|
| 1 | +# Contributing to adv-math |
| 2 | + |
| 3 | +👍 Thank you for your interest in contributing to `adv-math`! We welcome contributions from the community to help improve and enhance this mathematical library. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +Contributing to `adv-math` is easy and we appreciate every contribution. Follow these steps to get started: |
| 8 | + |
| 9 | +1. **Fork the Repository** |
| 10 | + |
| 11 | + Click the "Fork" button in the top right corner of this repository to create your own copy. |
| 12 | + |
| 13 | +2. **Clone the Repository** |
| 14 | + |
| 15 | + Clone the repository to your local machine using the following command (replace `[YOUR_USERNAME]` with your GitHub username): |
| 16 | + |
| 17 | + ```bash |
| 18 | + git clone https://github.com/[YOUR_USERNAME]/adv-math.git |
| 19 | + ``` |
| 20 | + |
| 21 | +3. **Create a Branch** |
| 22 | + |
| 23 | + Create a new branch for your contribution. Name the branch something related to the feature or bug you are working on. |
| 24 | + |
| 25 | + ```bash |
| 26 | + git checkout -b feature-or-bug-fix-name |
| 27 | + ``` |
| 28 | + |
| 29 | +4. **Make Changes** |
| 30 | + |
| 31 | + Make your desired changes to the codebase. Ensure that your changes follow the coding standards and guidelines of the project. |
| 32 | + |
| 33 | +5. **Write Tests** |
| 34 | + |
| 35 | + 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. |
| 36 | + |
| 37 | +6. **Run Tests** |
| 38 | + |
| 39 | + Before submitting your changes, make sure all tests pass. You can run tests using the following command: |
| 40 | + |
| 41 | + ```bash |
| 42 | + npm test |
| 43 | + ``` |
| 44 | + |
| 45 | + or |
| 46 | + |
| 47 | + ```bash |
| 48 | + yarn test |
| 49 | + ``` |
| 50 | + |
| 51 | + Fix any failing tests before proceeding. |
| 52 | + |
| 53 | +7. **Commit Changes** |
| 54 | + |
| 55 | + Commit your changes with a meaningful commit message. Please follow the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) if possible. |
| 56 | + |
| 57 | + ```bash |
| 58 | + git commit -m "feat: add new feature" # Use "feat" for new features |
| 59 | + ``` |
| 60 | + |
| 61 | +8. **Push Changes** |
| 62 | + |
| 63 | + Push your changes to your forked repository: |
| 64 | + |
| 65 | + ```bash |
| 66 | + git push origin feature-or-bug-fix-name |
| 67 | + ``` |
| 68 | + |
| 69 | +9. **Create a Pull Request (PR)** |
| 70 | + |
| 71 | + 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. |
| 72 | + |
| 73 | +10. **Review and Collaborate** |
| 74 | + |
| 75 | + Collaborate with maintainers and other contributors to address any feedback or discussions related to your PR. Be responsive to comments and make necessary changes. |
| 76 | + |
| 77 | +11. **Merge PR** |
| 78 | + |
| 79 | + Once your PR has been approved, a maintainer will merge your changes into the main branch. |
| 80 | + |
| 81 | +12. **Celebrate** |
| 82 | + |
| 83 | + Congratulations! You've successfully contributed to `adv-math`. Thank you for your contribution! |
| 84 | + |
| 85 | +## Code of Conduct |
| 86 | + |
| 87 | +Please review our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing to this project. We expect all contributors to adhere to these guidelines to create a positive and inclusive community. |
0 commit comments