-
Notifications
You must be signed in to change notification settings - Fork 135
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
Added CONTRIBUTING.md #751
Conversation
Signed-off-by: DarikshaAnsari <img_2021021@iiitm.ac.in>
@lukpueh I have change the file location. PTAL! |
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.
This is great! Many thanks!! I only have a few minor comments:
- I think we should make the headings less prominent to put more emphasis on the contents (see inline code suggestions).
- Links to
venv
andgit --sign-off
docs are probably helpful (see inline code suggestions). - The manual test snippet probably does not work. Please fix (see inline comment).
- Would you mind adding a link to this page in https://github.com/in-toto/in-toto?tab=readme-ov-file#governance-and-contributing?
Signed-off-by: DarikshaAnsari <img_2021021@iiitm.ac.in>
Signed-off-by: DarikshaAnsari <img_2021021@iiitm.ac.in>
Apart from the link this looks great! |
Ah, okay, I was suggesting to add a link, which points to docs/CONTRIBUTING.md, here: Lines 153 to 156 in 659942b
E.g. For information about in-toto's governance and contributing guidelines, see
[GOVERNANCE.md](GOVERNANCE.md) and [CONTRIBUTING.md](doc/CONTRIBUTING).md. |
Signed-off-by: Dariksha <img_2021021@iiitm.ac.in>
There still seems to be a misunderstanding. I was asking to make the suggested change in REAMDE.md. If you click on the link above, you'll get directly to the section, which I wanted you to update |
Signed-off-by: Dariksha <img_2021021@iiitm.ac.in>
Signed-off-by: Dariksha <img_2021021@iiitm.ac.in>
README.md
Outdated
For information about in-toto's governance and contributing guidelines, see | ||
[GOVERNANCE.md](GOVERNANCE.md) and [CONTRIBUTING.md](doc/CONTRIBUTING). |
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.
For information about in-toto's governance and contributing guidelines, see | |
[GOVERNANCE.md](GOVERNANCE.md) and [CONTRIBUTING.md](doc/CONTRIBUTING). | |
For information about in-toto's governance and contributing guidelines, see | |
[GOVERNANCE.md](GOVERNANCE.md) and [CONTRIBUTING.md](doc/CONTRIBUTING.md). |
Signed-off-by: Dariksha <img_2021021@iiitm.ac.in>
Signed-off-by: Dariksha <img_2021021@iiitm.ac.in>
Thanks! |
Fixes issue #749 :
Description:
The current in-toto repository has no contributing file, and the only information documented is available here, making it challenging for new contributors to get started. This issue aims to add a new contributing file to provide comprehensive and user-friendly instructions for potential contributors.
Proposed Changes: