Documentation: Update CONTRIBUTING docs #15187
Merged
Conversation
This file contains 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
gziolo
added
[Type] Enhancement
gziolo
requested review from
ajitbohra,
chrisvanpatten,
mkaz,
oandregal,
notnownikki and
youknowriad
as code owners
gziolo
force-pushed
the
update/contributing-docs
branch
from
82f5efa
to
b59c336
Compare
draganescu
approved these changes
Apr 26, 2019
There was a problem hiding this comment.
I think this is a step in the right direction for updating the contributing documentation structure. In the current file the length itself is a problem. where stopping at a certain point would require a lot of "scanning" to get back in the flow.
With this new structure two things are achieved:
- There is an easier way to follow instructions and read through them
- The information is easier to refer to, packed in individual smaller bits
|
@draganescu - thank you for confirming that this is the change in the right direction. I appreciate your input 👍 |
aduth
reviewed
Apr 30, 2019
| * [Coding Guidelines](/docs/contributors/coding-guidelines.md) outline additional patterns and conventions used in the Gutenberg project. | ||
| * [Gutenberg Block Grammar](/docs/contributors/grammar.md) |
There was a problem hiding this comment.
I don't know if it was intentional, but I like the reordering to have the more advanced topics arranged further down the list.
There was a problem hiding this comment.
Yes, my idea was to put at the top the most useful documents in the context of new contributions.
5 tasks
This was referenced Sep 11, 2024
This was referenced Sep 14, 2024
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.
Description
This PR seeks to make it easier to discover developer related documentation explaining how to contribute. It essentially extracts more detailed sections from the top level
CONTRIBUTING.mdfile to their own files. The side effect of this change is that they will be also exposed in Gutenberg Handbook in addition to GitHub repository.