We welcome contributions to Curvipy! Whether you are a seasoned developer or just getting started, there are many ways to get involved.
There are many ways to contribute to Curvipy without writing any code:
- Share Curvipy with others: Share the library with your friends, colleagues, and online communities. The more people that know about Curvipy, the more likely it is to grow and improve. Additionally, you can contribute to Curvipy by using it to explain math topics on blogs, YouTube, and other platforms. This helps to reach a wider audience and increases the visibility of the library.
- Improve documentation: Curvipy's documentation is always in need of improvement. If you see any typos, errors, or areas that could be clearer, feel free to open a pull request or issue to suggest improvements.
- Suggest new features: Do you have an idea for a new feature that would make Curvipy even better? We welcome feature proposals! Simply open an issue with your idea and we'll discuss it.
If you are interested in contributing code to Curvipy, here are a few things to keep in mind:
- Code formatting: Curvipy uses Black for code formatting. Please run Black on your code before submitting a pull request to ensure that it meets the project's formatting standards.
- Open an issue: Before making a pull request, we recommend opening an issue to discuss your proposed changes. This helps to ensure that your pull request is focused and addresses a specific problem or need.
- Commit messages: When committing your changes, please use clear and concise commit messages that starts with a verb in the present tense. For example: "Add new feature" or "Fix bug".
- Pull request template: When creating a pull request, please include a clear and concise description of the changes you are proposing. Be sure to follow the pull request template provided by the project.
We appreciate any and all contributions to Curvipy! Thank you for your interest in helping to improve the library❤️