Skip to content

Latest commit

 

History

History
74 lines (43 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

74 lines (43 loc) · 2.56 KB
Raw

Contributing to Quran Application

First off, thank you for considering contributing to this Quran Application! Contributions are a great way to enhance the project for everyone. Whether you're fixing a bug, improving documentation, or adding new features, your help is appreciated.

How to Contribute

1. Fork the Repository

  • Start by forking the repository. You can do this by clicking the "Fork" button on the repository page.

  • Clone your forked repository to your local machine:

    git clone https://github.com/cloud-premises/quran-app.git

  • Navigate to the project directory:

    cd quran-app

2. Create a Branch

  • Create a new branch for your changes. Use a descriptive name for your branch:

    git checkout -b feature/your-feature-name

3. Make Your Changes

  • Implement your feature, bug fix, or improvement. Ensure your code follows the project’s coding standards.
  • Make sure to write tests if you're adding new features or fixing bugs.
  • Test your changes thoroughly before submitting.

4. Commit Your Changes

  • Once your changes are made and tested, commit them using a clear and concise commit message:

    git add . git commit -m "Add feature: your feature description"

5. Push Your Changes

  • Push your changes to your forked repository:

    git push origin feature/your-feature-name

6. Create a Pull Request

  • Go to the original repository on GitHub and click on "Pull Request" to submit your changes.
  • Make sure to fill in the PR template with all necessary details.

7. Code Review

  • One of the project maintainers will review your pull request and may suggest changes.
  • Please be responsive to feedback and make necessary revisions.

Reporting Issues

If you encounter any bugs or have a feature request, feel free to open an issue.

When opening an issue, please provide:

  • Clear title and description of the problem.
  • Steps to reproduce the issue.
  • Environment details (operating system, browser, etc.).
  • Screenshots, if applicable.

Guidelines

  • Code Style: Adhere to existing code styles in the repository. Use linters if necessary.
  • Tests: All new features and fixes should come with relevant tests. If you're unsure how to test, please ask for guidance in the pull request.
  • Documentation: If your contribution affects the app's behavior, please ensure relevant documentation is updated.

Community Guidelines

Please ensure you adhere to our Code of Conduct when contributing.

Thank you for helping make this project better!