Skip to content

Latest commit

 

History

History
87 lines (50 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

87 lines (50 loc) · 2.73 KB
Raw

Contributing to adv-math

👍 Thank you for your interest in contributing to adv-math! We welcome contributions from the community to help improve and enhance this mathematical library.

How to Contribute

Contributing to adv-math is easy and we appreciate every contribution. Follow these steps to get started:

  1. Fork the Repository

    Click the "Fork" button in the top right corner of this repository to create your own copy.

  2. Clone the Repository

    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]/adv-math.git

  3. Create a Branch

    Create a new branch for your contribution. Name the branch something related to the feature or bug you are working on.

    git checkout -b feature-or-bug-fix-name

  4. Make Changes

    Make your desired changes to the codebase. Ensure that your changes follow the coding standards and guidelines of the project.

  5. Write Tests

    If you are adding new functionality or fixing a bug, write tests for your code in the tests/ directory. Ensure that your tests cover the functionality you have added or fixed.

  6. Run Tests

    Before submitting your changes, make sure all tests pass. You can run tests using the following command:

    npm test

    or

    yarn test

    Fix any failing tests before proceeding.

  7. Commit Changes

    Commit your changes with a meaningful commit message. Please follow the conventional commit format if possible.

    git commit -m "feat: add new feature"  # Use "feat" for new features

  8. Push Changes

    Push your changes to your forked repository:

    git push origin feature-or-bug-fix-name

  9. Create a Pull Request (PR)

    Go to the main repository and click on the "New Pull Request" button. Compare the changes between your branch and the main branch. Provide a clear and concise description of your changes in the PR.

  10. Review and Collaborate

    Collaborate with maintainers and other contributors to address any feedback or discussions related to your PR. Be responsive to comments and make necessary changes.

  11. Merge PR

    Once your PR has been approved, a maintainer will merge your changes into the main branch.

  12. Celebrate

    Congratulations! You've successfully contributed to adv-math. Thank you for your contribution!

Code of Conduct

Please review our Code of Conduct before contributing to this project. We expect all contributors to adhere to these guidelines to create a positive and inclusive community.