First, thank you for considering contributing to BonyanOSS. We welcome contributions from everyone who shares our vision of building Islamic and beneficial open-source software.
All projects under the BonyanOSS organization are licensed under the MIT License. By contributing to any BonyanOSS repository, you agree that your contributions will be licensed under its MIT License.
Before starting work, please check the existing issues to see if someone else is already working on it.
- If you find an issue you would like to work on, leave a comment stating your intent.
- If you have a new feature idea or have found a bug, please create a new issue to discuss it before submitting a pull request.
Fork the repository you wish to contribute to and clone it locally.
Create a new branch for your feature or bugfix. Use a descriptive naming convention:
feature/description-of-featurefix/description-of-fixdocs/description-of-docs-update
- Follow the existing code style of the project.
- Write clear, understandable, and maintainable code.
- Add comments to complex areas.
- If applicable, add or update tests.
Once your changes are complete, submit a Pull Request (PR) against the main branch of the original repository.
- Use the provided Pull Request template.
- Ensure your PR description clearly states the problem and the solution.
- Link any related issues in the PR description.
All submissions require review. We aim to review PRs as quickly as possible. Please be open to feedback and necessary revisions.
We operate under a simple principle: build beneficial software and allow the community to grow. Keep communications professional, respectful, and focused on building meaningful open-source tools.