We welcome contributions from the community to improve Quran Mailer! If you would like to contribute, please follow these guidelines:
- Fork the repository on GitHub.
- Clone your forked repository to your local machine.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure they follow the project's coding style and conventions.
- Run the test suites and modify your code if anyone failed till all test suites succeed.
- Commit your changes and provide a descriptive commit message.
- Push your changes to your forked repository.
- Submit a pull request to the main repository, explaining the changes you've made and why they should be merged.
- Be responsive to any feedback or questions regarding your pull request.
If you don't have any idea about what to contribute with, here are some ideas:
- Adding Quranic Verses: Contribute by adding new Quranic verses to the verses.js file. Ensure verses are not duplicated.
- Feature Requests: Suggest new features on the
issuespage. - Bug Reports: Report errors or bugs on the
issuespage. - Issue Resolution: Address validated issues from the
issuespage. - Code Updates and Refactoring: Refactor code or make updates to enhance the project.
- Documentation: Help improve the project's documentation, including the
README.mdfile. - Add Test Cases: Add more test cases that can help keep the code quality high over time.
For more detailed guidance on contributing to open source projects, check out this YouTube playlist: Contributing to Open Source Projects (in Arabic).
Before contributing, please review our Code of Conduct to understand the behaviors we expect in our community.
If you have any questions or need assistance, feel free to reach out to us by opening an issue or emailing [email protected] or [email protected].
We appreciate your contributions to Quran Mailer!