Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (34 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.66 KB
Raw

Contributing to Pyre Documentation

Thank you for considering contributing to the Pyre documentation! We welcome all contributions, whether they are small or large.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine.

    git clone https://github.com/your-username/pyre-docs.git

  3. Create a Branch: Create a new branch for your changes.

    git checkout -b my-feature-branch

  4. Make Changes: Make your changes to the documentation.

  5. Commit Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Description of changes"

  6. Push Changes: Push your changes to your forked repository.

    git push origin my-feature-branch

  7. Open a Pull Request: Open a pull request to the main repository. Provide a clear description of your changes and any related issues.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Reporting Issues

If you find any issues or have suggestions, please open an issue in the repository. Provide as much detail as possible to help us understand and address the issue.

Style Guide

  • Use clear and concise language.
  • Follow the existing style and format of the documentation.
  • Use proper Markdown syntax.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions!