Refactor the CONTIBUTING.md docs #32
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Grillo-0
force-pushed
the
contrib-docs-refactor
branch
13 times, most recently
from
23d4f6e to
7420240
Compare
monacofj
reviewed
Jun 4, 2025
Grillo-0
force-pushed
the
contrib-docs-refactor
branch
from
7420240 to
1baf375
Compare
arthurvergacas
approved these changes
Jun 10, 2025
Grillo-0
force-pushed
the
contrib-docs-refactor
branch
from
1baf375 to
2364d26
Compare
For standardization and simplicity let's use the more common header notation style.
Indentation in this case just makes it harder to read and write the raw file, just remove it.
The list has a wrong item syntax on the end and also doesn't have a link to the files.
I realy don't care how you name your PR branches, they are ephemeral.
I think these tags fill up the first commit line than they give some useful information. Also the commit message guidelines are not descriptive enough. Try to write a better guideline following this great blogpost[1]. [1]: https://cbea.ms/git-commit/
Grillo-0
force-pushed
the
contrib-docs-refactor
branch
from
2364d26 to
c446e62
Compare
I don't think is necessary to create an issue before doing an PR, it just make the contribution process more cumbersome.
We don't need this exception, every contribution must pass the same process.
Be more specific about what is the target branch to use. And also write that the tests are obligatory for a PR to be accepted.
Markdown has a feature to make links, let's use it instead of having a list of references.
This is done to remove redundant information.
Grillo-0
force-pushed
the
contrib-docs-refactor
branch
from
c446e62 to
fbdface
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change the contributing rules to make it less cumbersome and specify the style of commit messages.