Please follow the steps and guidelines below to ensure a smooth process.
- Fork this repository to your own GitHub account.
- Create a new branch in your forked repository. Use a naming convention that clearly indicates the project name you belong to, for example: projects/
- Make your changes (see What to Contribute).
- Submit a Pull Request (PR) from your branch to the main repository.
- Each Pull Request must include exactly one (1)
.md
file placed inside the/projects
folder. - The name of the
.md
file will be used as the URL path on the Reserve Protocol website. For example, if your file is namedmy-project.md
, the URL path will be based on/my-project
.
- All incoming PRs are reviewed by the maintainers.
- Once approved, your contribution will proceed to a manual deployment process before appearing on the Reserve Protocol website.
- Only PRs from verified members of the projects are allowed.
- Please follow Markdown best practices when creating your
.md
file. - You can also use the documentation creation tool provided by Reserve at http://reserve.org/doc-creator/ to generate an
.md
file and get a live preview of how it will appear on the site. - Ensure that your content is accurate and clear.
- Keep your commit history clean and minimal for easier review.
Thank you for contributing to Reserve Protocol. We appreciate your time, effort, and adherence to these guidelines!