-
Notifications
You must be signed in to change notification settings - Fork 380
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: add first development guide #29
Conversation
949c43e
to
27e191d
Compare
## Development Setup | ||
|
||
Documentation for Development setup is [here][develop]. | ||
|
||
[develop]: ./DEVELOP.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
WDYT about folding DEVELOP.md into here as a flat section? I'd rather not have it buried behind two clicks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@willfindlay sure, done.
regarding the file location: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
i vote for putting CONTRIBUTING.md at the root directory to be consistent with cilium https://github.com/cilium/cilium/blob/master/CONTRIBUTING.md |
+1, this is also consistent with how many projects do it. |
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: cilium#33 Signed-off-by: Djalal Harouni <[email protected]>
… guide Include the DEVELOP.md file directly into the Development Guide to make it simple for developers. Signed-off-by: Djalal Harouni <[email protected]>
This patch adds section describing how to make changes to your tetragon repo fork. Signed-off-by: Djalal Harouni <[email protected]>
27e191d
to
e4605dd
Compare
@michi-covalent @willfindlay done, hope I did get it all. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great
Tetragon Open Source project was just released and it does not include
default contributing guidelines.
This patch fixes this by adding:
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
Development guide under docs directory with a section on how to submit pull requests.
Moves the DEVELOP.md file from root directory to the
docs/contributing/development/
one.Fixes: #33
Signed-off-by: Djalal Harouni [email protected]