Added CONTRIBUTING.md file #58
Conversation
Signed-off-by: Ayush Gupta <[email protected]>
| - Include these points in one or more comments. | ||
| 3. **Start Work**: Begin working on the issue only after it has been assigned to you. | ||
| 4. **Avoid Conflicts**: Only start working on the issue and open a Pull Request after it has been assigned to you. This prevents confusion, duplicate work, and potential conflicts among contributors. | ||
| 5. **Reference the Issue**: In your Pull Request, reference the issue (e.g., `This PR fixes #1234`). This ensures the issue is automatically closed when your Pull Request is merged. |
There was a problem hiding this comment.
Hi @Ayush9026, I think we don't have functionality of auto closing the issue. See even Referencing the issue in PR, we have to close it manually see . So IMO we should remove this part.
|
|
||
| The theupdateframework.io site is built using HTML and Javascript. | ||
|
|
||
| Check out the set of contributing guides available at https://theupdateframework.readthedocs.io/en/latest/CONTRIBUTING.html |
There was a problem hiding this comment.
Also, why referencing python-tuf's Instructions for contributors here? That page contains
- DCO
- Testing
- Unit tests
- Coverage
- Auto formatting
Which completely based on python-tuf repo, does not relates to theupdateframework.io repository.
Thank you 👍
There was a problem hiding this comment.
Hi @h4l0gen,
Thank you for the feedback! 👍 You’re right, referencing the python-tuf’s instructions isn't relevant here. I’ll update the contributing guide to better reflect the specifics of the theupdateframework.io repository.
Thanks for pointing that out! 🙌
There was a problem hiding this comment.
Please just wait for official maintainer's review, before making any commit. I am not official maintainer, so there review is must required on if my review is correct or not. I hope you understand. Thank you 👍
There was a problem hiding this comment.
Hi @h4l0gen ,
Of course, I understand. I'll wait for the official maintainers' review before making any changes.
| @@ -0,0 +1,61 @@ | |||
| # Contributing to theupdateframework.io | |||
There was a problem hiding this comment.
@Ayush9026 you did a wonderful work, I've just a small suggestion, should we add testing guidelines too, on how to test changes locally same as python-tuf CONTRIBUTING guideline.. Steps can be this:
-
Execute the following command to install the project's dependencies locally:
$ yarn install -
Start the Hugo development server to preview the website locally by running:
$ hugo server -
Once started, the website will be accessible at: http://localhost:1313/ by default. And review your changes.
Thank you 👍
There was a problem hiding this comment.
| > - **Seek Clarity**: If an issue is unclear, ask questions to get more information before requesting to be assigned. Avoid asking vague questions like "what do I do next?" or "how do I fix this?" | ||
| > - **Collaboration**: An issue can be assigned to multiple people if all parties agree to collaborate on it. The pull request can contain commits from different collaborators. | ||
| > - **Inactivity**: Any issue with no activity for 2 weeks will be unassigned and re-assigned to someone else. | ||
|
|
There was a problem hiding this comment.
IMO we should add DCO section clearly in CONTRIBUTING.md. In every CNCF project it is included see here in python-tuf, just for reference. WYT? @Ayush9026
Any suggestions @lukpueh @joshuagl
Thank you 👍
Description
This PR solved issue #50 . To enhance the contribution process and provide clear guidelines for new and existing contributors, we need to add a CONTRIBUTING.md file to the theupdateframework.io repository.