Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

77 lines (51 loc) · 3.81 KB

Contributing to Luuqad

Thank you for considering contributing to Luuqad! We appreciate your time and effort in making this project better.

Table of Contents

  1. How to Contribute
  2. Code Contribution
  3. Issue Reports
  4. Pull Requests
  5. Style Guidelines
  6. Code of Conduct

How to Contribute

Before you start contributing, please take a moment to read and understand this guide. It will help streamline the contribution process and ensure that everyone is on the same page.

To New Contributors

Before starting code contribution first:

  1. Check previous issues and read
  2. Ask to be assign an existing issue or create new issue
  3. After when assigned to you an issue follow the code contribution steps, below this.

Code Contribution

If you want to contribute code to the project, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Create a new branch from the main branch with a descriptive name: git checkout -b my-feature-branch.
  3. Make your changes and improvements.
  4. Run tests (if applicable) to ensure nothing is broken.
  5. Commit your changes with a clear and descriptive commit message: git commit -m "Add feature X".
  6. Push your branch to your forked repository: git push origin my-feature-branch.
  7. Open a pull request (PR) against the main branch, clearly explaining your changes and the problem it solves.

Issue Reports

If you have a suggestion for a new feature or enhancement or found a bug, please submit an issue request. To do so, follow these steps:

  • Check the existing issues to see if the issue has already been reported.
  • If not, create a new issue, a template will be provided and enter as much detail as possible, including steps to reproduce what the issue is and information about your environment.

Pull Requests

We welcome and appreciate pull requests from contributors. To submit a pull request, please follow these guidelines:

  • When creating a new pull request, a Pull request template will be provided
  • Make sure your PR addresses an existing issue or clearly explains its purpose.
  • Include a concise description of your changes in the PR description.
  • Your code should follow our Style Guidelines.
  • Tests (if applicable) should be included and passed successfully.

Code of Conduct

Contributors are expected to follow our Code of Conduct, both in interactions related to the project and within the project's community. The full Code of Conduct can be found in the CODE OF CONDUCT file.

Contributors

Duraan Ali Mahamed Mahad Abdiwali Maxamed A.shakour Mohammed 0dayx16 jamaal mahamed maska

Questions or Need Help?

If you have any questions or need further assistance, feel free to Ask the Admin or open an issue.

By contributing to this project, you agree to abide by the terms outlined in this document.

Thank you for contributing!