Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 2.5 KB
Raw

Contribution Guidelines

Thank you for considering contributing to this project! Contributions are highly appreciated and welcomed. To ensure a smooth collaboration, please review the following guidelines.

Reporting Issues

If you come across any issues or bugs while using this project, please help us by reporting them. To submit an issue, follow these steps:

  1. Go to the Issues tab on the GitHub repository.
  2. Click on the "New Issue" button.
  3. Provide a descriptive title and detailed description of the issue, including any error messages or steps to reproduce.
  4. If applicable, add relevant labels or tags to categorize the issue.
  5. Submit the issue and wait for further instructions or clarifications.

Feature Requests

Have a great idea for a new feature or improvement? We'd love to hear it! Follow these steps to suggest a feature:

  1. Go to the Issues tab on the GitHub repository.
  2. Click on the "New Issue" button.
  3. Clearly describe the proposed feature or improvement, including any use cases or benefits.
  4. Submit the feature request and engage in any discussions or feedback related to it.

Pull Requests

We welcome contributions in the form of pull requests only to the dev branch. To submit a pull request, please follow these guidelines:

  1. Fork the repository and create your branch.
  2. Make the necessary code changes or improvements in your branch.
  3. Ensure your code adheres to the project's coding style and guidelines.
  4. Document any relevant changes or updates in the project's documentation.
  5. Submit the pull request, providing a clear title and description of the changes made.
  6. Engage in any feedback or discussions related to your pull request.

Code Style and Guidelines

To maintain consistency throughout the project's codebase, please adhere to the following guidelines:

  • Follow the Dart coding style conventions.
  • Use meaningful variable and function names.
  • Add comments when necessary to explain complex logic or intent.
  • Ensure code is properly formatted by using dartfmt.

Commit Structure

Make sure to use conventional commit structure as follows:

<type>: <short summary>
  │               │
  │               └─⫸ Summary. Not capitalized. No period at the end.
  │
  └─⫸ Commit Type: docs|feat|fix|perf|refactor|test

Know more about Conventional Commits here.