Submitting a pull request
Submitting a pull request
Contributions must be submitted in the form of pull requests against the upstream GitHub repository at https://github.com/cilium/tetragon.
Fork the Tetragon repository.
Push your changes to the topic branch in your fork of the repository.
Submit a pull request on https://github.com/cilium/tetragon.
Before hitting the submit button, please make sure that the following requirements have been met:
Each commit compiles and is functional on its own to allow for bisecting of commits.
All code is covered by unit and/or runtime tests where feasible.
All changes have been tested and checked for regressions by running the existing testsuite against your changes.
All commits contain a well written commit description including a title, description and a
Fixes: #XXX
line if the commit addresses a particular GitHub issue identified by its number. Note that the GitHub issue will be automatically closed when the commit is merged.doc: add contribution guideline and how to submit pull requests Tetragon Open Source project was just released and it does not include default contributing guidelines. This patch fixes this by adding: 1. CONTRIBUTING.md file in the root directory as suggested by github documentation: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors 2. Development guide under docs directory with a section on how to submit pull requests. 3. Moves the DEVELOP.md file from root directory to the `docs/contributing/development/` one. Fixes: #33 Signed-off-by: Djalal Harouni <djalal@cilium.io>
Note: Make sure to include a blank line in between commit title and commit description.
All commits are signed off. See the section Developer’s Certificate of Origin.
All important steps in Making changes have been followed.
Frequently Asked Questions
CI is complaining about Go module vendoring, what do I do?
You can run make vendor
then add and commit your changes.
CI is complaining about a missing “signed-off-by” line. What do I do?
You need to add a signed-off-by line to your commit messages. The easiest way
to do this is with git fetch origin/main && git rebase --signoff origin/main
.
Then push your changes.