Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 2.38 KB

Contributing to the Geometry Library

Thank you for considering contributing to the Geometry library! Contributions are crucial to improving the functionality and robustness of the library. Please take a moment to review the guidelines before making your contribution.

How to Contribute

  1. Fork the Repository: Click on the "Fork" button at the top right of the Geometry repository to create a copy of the repository on your GitHub account.

  2. Clone your Fork: Clone the repository to your local machine using the following command (replace your-username with your GitHub username):

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

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

    git checkout -b feature/your-contribution

  4. Make Changes: Implement your changes or additions to the library. Ensure that your code follows the project's coding standards.

  5. Run Tests: If applicable, run any tests associated with your changes to ensure they do not introduce new issues.

  6. Commit Changes: Commit your changes with a clear and descriptive commit message:

    git commit -m "Add feature: your contribution"

  7. Push Changes: Push your changes to your forked repository on GitHub:

    git push origin feature/your-contribution

  8. Submit a Pull Request: Open a pull request (PR) on the main Geometry repository. Provide a detailed description of your changes and why they are valuable. Reference any related issues in your PR description.

Code Style

Follow the existing code style and conventions used in the project. If there are specific style guidelines, they will be outlined in the project's documentation.

Testing

If your contribution includes new features or modifications, it is encouraged to include tests. Tests should be located in the tests directory and be named appropriately.

Issue Tracker

Before starting work on a new feature or bug fix, check the issue tracker for existing issues. If you plan to address an existing issue, please comment on it to let others know you are working on it.

Thank You!

Your contributions help make the Geometry library a valuable resource for the Python community. Thank you for your time and effort!