chore: Update contributing guide about commits #1870
Conversation
CONTRIBUTING.md
Outdated
| ``` | ||
| feat: allow provided config object to extend other configs | ||
| ``` | ||
| [Conventional commit]: https://www.conventionalcommits.org/ |
There was a problem hiding this comment.
Conventional starts with an upper-case here, whereas the other bullet points don't.
There was a problem hiding this comment.
Conventional Commits is written uppercase: https://www.conventionalcommits.org/en/v1.0.0/
I updated Commit to also be uppercase, as both are also written in uppercase on the webpage.
Also, just to be sure if you are not aware of them, these are not bullet points, but Reference-style Links where they are replaced above in the text (L#49)
| ### Building Monaco | ||
| To build Monaco, execute the following command in the repository root folder: | ||
| ```shell | ||
| go build ./cmd/monaco |
There was a problem hiding this comment.
make build and other targets reference generating mocks, which is left out here with no replacement and could lead to confusion when building/running tests/...
There was a problem hiding this comment.
Building Monaco should be independent of the mocks, testing is just not.
I added the info to the Testing .... header.
Laubi
force-pushed
the
chore/update-contributing-guide
branch
2 times, most recently
from
2c6aed3 to
1ce8cca
Compare
tomazpu
force-pushed
the
chore/update-contributing-guide
branch
from
1ce8cca to
53d5eb8
Compare
Update the 'building/running' section of the contrib guidelines to ditch the Makefile.
Laubi
force-pushed
the
chore/update-contributing-guide
branch
from
53d5eb8 to
6a142c0
Compare
|
What this PR does / Why we need it:
Updates the contributing guide to specify what conventional-commit prefixes are available, and when to use which one.
Special notes for your reviewer:
I started also updating the contribution guide in regard to the "how to run tests" and "how to build monaco" sections, but stopped myself, in case it's worse then before. This is the 2nd commit. If we want to have it in, we can adopt it, otherwise I have no issues in dropping the 2nd commit.