Skip to content
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

Merged
merged 3 commits into from
May 17, 2022

Conversation

tixxdz
Copy link
Member

@tixxdz tixxdz commented May 16, 2022

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 [email protected]

Comment on lines 46 to 50
## Development Setup

Documentation for Development setup is [here][develop].

[develop]: ./DEVELOP.md
Copy link
Contributor

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@willfindlay sure, done.

@michi-covalent
Copy link
Contributor

regarding the file location: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, docs, or .github folder.

i vote for putting CONTRIBUTING.md at the root directory to be consistent with cilium https://github.com/cilium/cilium/blob/master/CONTRIBUTING.md

@willfindlay
Copy link
Contributor

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.

tixxdz added 3 commits May 17, 2022 17:02
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]>
@tixxdz tixxdz force-pushed the pr/tixxdz/contribute-doc branch from 27e191d to e4605dd Compare May 17, 2022 16:20
@tixxdz
Copy link
Member Author

tixxdz commented May 17, 2022

@michi-covalent @willfindlay done, hope I did get it all.

Copy link
Contributor

@willfindlay willfindlay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add first documentation for contribution and developement
3 participants