Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

73 lines (52 loc) · 2.27 KB

Contributing to num-quaternion

Thank you for considering contributing to num-quaternion! We appreciate your support and effort in improving the project. Below are some guidelines to help you get started.

Getting Started

  1. Fork the Repository: Click the "Fork" button at the top right corner of the repository page.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/your-username/num-quaternion.git
cd num-quaternion

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

    git checkout -b my-feature-branch

Making Changes

  1. Code Style: Follow the Rust coding standards and style guidelines. Ensure your code is clean and well-documented. Testing: Add tests for any new features or bug fixes. Run all tests to make sure your changes do not break anything.

    cargo test

  2. Commit Messages: Write clear and concise commit messages. A good commit message should describe what changed and why.

    git commit -m "Add feature X to improve Y"

Submitting a Pull Request

  1. Push to Your Fork: Push your changes to your forked repository.

    git push origin my-feature-branch

  2. Open a Pull Request: Go to the original repository and open a pull request from your fork. Provide a clear description of your changes and the problem they solve or the feature they add.

Reviewing and Feedback

  • Your pull request will be reviewed by the maintainers. Please be open to feedback and make the necessary changes to ensure the quality of the codebase.
  • Once your pull request is approved, it will be merged into the main branch.

Recognition

We appreciate all contributions, and as a token of gratitude, all contributors will be mentioned in the release notes in RELEASES.md.

License

By contributing, you agree that your contributions will be dual-licensed under the Apache-2.0 and MIT licenses.

Questions and Issues

If you have any questions or need help, feel free to open an issue on GitHub.

Thank you for contributing to num-quaternion!