First off, thank you for considering contributing to Fast-Poisson-Solver. It's people like you that make Fast-Poisson-Solver such a great tool. We value all the people who want to contribute in any way possible.
There are many ways you can directly contribute to the project:
- Submit bug reports and feature requests, or help us improve our documentation
- Write, refactor, or optimize code in the project
- Implement testing (which is currently lacking in the project)
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone. Please refer to our Code of Conduct for details.
The process for submitting changes to Fast-Poisson-Solver is as follows:
- Fork the project, clone your fork to your machine, and configure the upstream remote
- Create a new branch in your local repo for your changes. Please use a name that describes the change you are making
- Make your changes in your new branch. If you are making code changes, please ensure they follow the style of the existing code and that your documentation follows the numpy style
- Push your changes to your fork
- Submit a pull request from your fork to the main branch of the original repo
We will review your pull request as soon as possible. Please understand that it may take some time to get a response due to time constraints, but we appreciate your patience.
Please use the issues tab in our GitHub repository to submit bug reports and feature suggestions. This helps us to keep track of everything in one place.
If you have any questions or run into any problems, please create an issue in our GitHub repository.
To be added.
Please ensure that any contributions match the style of the existing code. For documentation, we are using the numpy style.