Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.54 KB
Raw

Contributing to Numeraire Documentation

Thank you for your interest in contributing to the Numeraire documentation! We welcome all types of contributions, including issues, improvements, and new content. This guide will help you get started.

How to Contribute

1. Reporting Issues

If you find any issues or errors in the documentation, please open an issue in this repository. Provide as much detail as possible, including links to the affected pages.

2. Proposing Changes

If you have suggestions for improvements, follow these steps:

  1. Fork this repository.
  2. Create a new branch (git checkout -b my-feature-branch).
  3. Make your changes in the docs/ directory.
  4. Test your changes locally by running yarn start.
  5. Commit your changes (git commit -am 'Add my feature').
  6. Push the branch to your fork (git push origin my-feature-branch).
  7. Open a Pull Request in this repository.

3. Writing New Documentation

  • Follow the existing structure and style when adding new content.
  • Use Markdown for all documentation files.
  • Keep the language clear and concise.
  • Add your new files to the appropriate section in sidebars.js to ensure they appear in the documentation.

4. Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

5. License

By contributing, you agree that your contributions will be licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).

Thank you for your contributions!