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

Added CONTRIBUTING.md #751

Merged
merged 8 commits into from
May 21, 2024
Merged

Conversation

DarikshaAnsari
Copy link
Contributor

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:

  • Quick Start Guide: Add basic steps for contributing.
  • Installation Instructions: Provide detailed setup instructions.
  • Contribution Guidelines: Expand on coding standards, testing requirements, and PR process.
  • DCO Signing: Explain the importance and provide signing instructions.
  • Testing Instructions: Include tox usage and manual testing guidelines.
  • Code Formatting: Add guidelines for consistent code formatting.
  • Documentation Building: Provide instructions for local documentation generation.

Signed-off-by: DarikshaAnsari <img_2021021@iiitm.ac.in>
@DarikshaAnsari
Copy link
Contributor Author

@lukpueh I have change the file location. PTAL!

Copy link
Member

@lukpueh lukpueh left a 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 and git --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?

doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: DarikshaAnsari <img_2021021@iiitm.ac.in>
Signed-off-by: DarikshaAnsari <img_2021021@iiitm.ac.in>
@lukpueh
Copy link
Member

lukpueh commented May 17, 2024

Would you mind adding a link to this page in https://github.com/in-toto/in-toto?tab=readme-ov-file#governance-and-contributing?

Apart from the link this looks great!

@DarikshaAnsari
Copy link
Contributor Author

I have added link here in contribution guidelines,

Screenshot 2024-05-17 140108

@lukpueh
Copy link
Member

lukpueh commented May 17, 2024

Ah, okay, I was suggesting to add a link, which points to docs/CONTRIBUTING.md, here:

in-toto/README.md

Lines 153 to 156 in 659942b

## Governance and Contributing
For information about in-toto's governance and contributing guidelines, see
[GOVERNANCE.md](GOVERNANCE.md).

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>
@lukpueh
Copy link
Member

lukpueh commented May 17, 2024

Ah, okay, I was suggesting to add a link, which points to docs/CONTRIBUTING.md, here:

in-toto/README.md

Lines 153 to 156 in 659942b

## Governance and Contributing
For information about in-toto's governance and contributing guidelines, see
[GOVERNANCE.md](GOVERNANCE.md).

E.g.

 For information about in-toto's governance and contributing guidelines, see 
 [GOVERNANCE.md](GOVERNANCE.md) and [CONTRIBUTING.md](doc/CONTRIBUTING).md.

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
Comment on lines 155 to 156
For information about in-toto's governance and contributing guidelines, see
[GOVERNANCE.md](GOVERNANCE.md) and [CONTRIBUTING.md](doc/CONTRIBUTING).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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>
@lukpueh lukpueh merged commit f69347b into in-toto:develop May 21, 2024
16 checks passed
@lukpueh
Copy link
Member

lukpueh commented May 21, 2024

Thanks!

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.

None yet

2 participants