Create a Pull Request Template for the project #2387
+19
−0
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
Adds a pull request template to provide information on how to contribute to Tetragon.
lambdanis
added
the
release-note/misc
lambdanis
requested changes
Apr 29, 2024
.github/pull_request_template.md
Outdated
|
|
||
| - [ ] For first time contributors, read [Submitting a pull request](https://tetragon.io/docs/contribution-guide/submitting-a-pull-request/). | ||
| - [ ] All code is covered by unit and/or end-to-end tests tests where feasible. | ||
| - [ ] All commits contain a well written commit description including a title, |
There was a problem hiding this comment.
Suggested change
| - [ ] All commits contain a well written commit description including a title, | |
| - [ ] All commits contain a well written commit message including a title, |
tixxdz
reviewed
May 3, 2024
There was a problem hiding this comment.
LGTM when @lambdanis and other comments are fixed.
Thank you ;-)
.github/pull_request_template.md
Outdated
|
|
||
| - [ ] For first time contributors, read [Submitting a pull request](https://tetragon.io/docs/contribution-guide/submitting-a-pull-request/). | ||
| - [ ] All code is covered by unit and/or end-to-end tests tests where feasible. | ||
| - [ ] All commits contain a well written commit description including a title, |
Tetragon currently does not have a pull request template to provide contributors with directions on how to contribute to the project on Github. This patch fixes this by adding: 1. pull_request_template.md file covering the important information contributors need to open request that checks that required criteria. Fixes: cilium#1929 Signed-off by: Paul Arah <paularah.self@gmail.com>
|
Thanks for the update @paularah. The PR template looks good, now we need to clean up the git history. To keep the git history readable, we avoid merge commits and we squash changes requested in code review into existing commits. Here is how I would do it: # Switch to main branch
git switch main
# Add cilium/tetragon repo as upstream
git remote add upstream git@github.com:cilium/tetragon.git
# Make your local main branch track main branch from upstream instead of your fork
git branch -u upstream/main
# Reset your local main branch to upstream main branch
git fetch upstream
git reset --hard upstream/main
# Switch to your branch
git switch pr/paularah/pr_template
# Rebase with main branch
git rebase main
# Now the merge commit should be gone, check the git history. If it looks ok, reset last 2 commits.
git log
git reset HEAD~2
# Create a new commit (-s adds the sign-off line) and write a descriptive commit message
git add .
git commit -s
# Force push
git push -f |
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.
Fixes: #1929
Adds a pull request template to provide information on how to contribute to Tetragon.