docs: Improve contribution guide & PR template #2483
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
lambdanis
added
area/documentation
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
lambdanis
changed the title
Adding initial contribution guides for specific areas. Mainly instructions for generating files, some of which I moved from the "development setup" page. Signed-off-by: Anna Kapuscinska <[email protected]>
Tetragon contribution guide consists of a few docs pages and a PR template, each one containing a list of steps. Many of the steps (e.g. testing or commit message guidelines) are duplicated between lists. This is hard to follow and hard to maintain (different pages can easily become conflicting). I refactored the contribution guide so that it's (hopefully) easier to follow: * "Making changes" page has simplified build & test instructions. I added a step about code generation and removed a step about commits. * "Submitting a pull request" page covers everything related to commits (in a dedicated section) and basic info about pull request review. I added a link to the main contribution guide and removed other steps, which were duplicating the previous guides * Checklist in the PR template is simplified and links to docs pages. Signed-off-by: Anna Kapuscinska <[email protected]>
lambdanis
force-pushed
the
pr/lambdanis/contribution-guide
branch
from
7f37255 to
dcf0010
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.
Tetragon contribution guide consists of a few docs pages and a PR template,
each one containing a list of steps. Many of the steps (e.g. testing or commit
message guidelines) are duplicated between lists. This is hard to follow and
hard to maintain (different pages can easily become conflicting).
I refactored the contribution guide so that it's (hopefully) easier to follow:
about code generation and removed a step about commits.
a dedicated section) and basic info about pull request review. I added a link
to the main contribution guide and removed other steps, which were
duplicating the previous guides