Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 2.42 KB
Raw

Contribution Guidelines

Thank you for considering contributing to our project! To ensure smooth collaboration, please follow these guidelines:

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your feature/bugfix: git checkout -b feature/your-feature.
  3. Make your changes and ensure they follow our coding style and conventions.
  4. Test your changes thoroughly.
  5. Commit your changes: git commit -am 'Add new feature'.
  6. Push to your branch: git push origin feature/your-feature.
  7. Open a pull request (PR) to the main branch of our repository.

Issue Reporting

  1. Search Before Creating: Before creating a new issue, please search the issue tracker to avoid duplicates.
  2. Provide Details: When creating an issue, provide as much detail as possible:
    • Steps to reproduce the issue.
    • Expected behavior.
    • Actual behavior.
    • Screenshots or error messages, if applicable.
  3. Label Appropriately: Use the relevant labels (bug, enhancement, documentation, etc.) for your issue.
  4. Be Respectful: Use clear and respectful language in issue descriptions and comments.
  5. Follow Up: If more information is requested, respond promptly to keep the discussion active.

Pull Request Guidelines

  • Ensure your PR has a descriptive title and includes details of the changes made.
  • Link related issues to your PR if applicable.
  • Include screenshots or GIFs if your changes affect the UI/UX.
  • Ensure your code passes all tests and doesn't introduce new issues.

Community Guidelines

  • Be respectful and considerate of others' ideas and contributions.
  • Provide constructive feedback and support to fellow contributors.

Contribution Don'ts

  1. Avoid making extensive changes in a single pull request; smaller, focused changes are easier to review and merge.
  2. Avoid creating duplicate issues; search the issue section before creating a new one.
  3. Don't submit PRs with untested or unfinished code; ensure your changes are fully functional.
  4. Avoid making changes to the project's architecture without prior discussion and agreement.
  5. Don't include unnecessary files, code, or dependencies in your pull requests.
  6. Avoid engaging in disrespectful or offensive behavior within comments, issues, or pull requests.

License

By contributing to our project, you agree that your contributions will be licensed under our project's license.