FOSSTrak Feature Request: Document Contribution Process for Adding Events
TLDR;
This feature request proposes adding documentation to the FOSSTrak project detailing
the process for contributing events to the repository. The documentation will include
step-by-step instructions on forking the repository, cloning it, adding event information
in JSON format, committing changes, and creating a pull request (PR). This documentation
will enhance accessibility for contributors and foster community engagement.
Thank you for considering this enhancement to the project documentation!
Feature Description
Add documentation detailing the contribution process for adding events to the repository using a specific JSON format.
Use Case
Users who want to contribute events to the repository need clear instructions on how to format and submit event information.
Proposed Solution
Create a new section in the project documentation outlining the step-by-step process for contributing events:
Forking the repository
Cloning the forked repository
Adding event information in JSON format
Committing changes and creating a pull request (PR)
Alternatives Considered
We considered providing a video tutorial or conducting live workshops, but a written guide in the documentation is more accessible and scalable.
Dependencies
The documentation update depends on having a clear understanding of the JSON format required for event submissions.
FOSSTrak Feature Request: Document Contribution Process for Adding Events
Feature Description
Add documentation detailing the contribution process for adding events to the repository using a specific JSON format.
Use Case
Users who want to contribute events to the repository need clear instructions on how to format and submit event information.
Proposed Solution
Create a new section in the project documentation outlining the step-by-step process for contributing events:
Alternatives Considered
We considered providing a video tutorial or conducting live workshops, but a written guide in the documentation is more accessible and scalable.
Dependencies
The documentation update depends on having a clear understanding of the JSON format required for event submissions.
Here is the sample format for reference: