Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 3.34 KB
Raw

Contributing Guidelines

This document contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve this project in any way. Thank you for choosing this repository to contribute and helping out this project grow, We accept contributions of every size.

Before you begin:

Table of Contents :

Project Conventions

  • All the screen that you make must be inside screens folder and filename should be of the pattern _screen.dart
  • All the explicit widget created must go inside widgets folder and filename should be of the pattern _widget.dart
  • All the styles that are implement would go into separate file NOT inline.

Find an issue ( or make one ) :

  • Note : Every change in this project should have an associated issue ( very small changes can be an exception but it's still recommended to have an issue for you change ).
  • You can also skip this step if the contribution is small ( obvious fixes or typos ) and directly create a PR with the required changes.
  • Take a look at the Existing Issues or create your own Issue if you don't find any that tickle your fancy.
  • Show your interest by commenting on the issue you want to work on and the maintainers will assign you the issue.

Labels

Labels can help you find an issue you'd like to help with.

  • The help wanted label is for problems or updates that anyone in the community can start working on.
  • The good first issue label is for problems or updates we think are ideal for beginners.

Work on the issue assigned

  • Make sure the changes follow our Project Conventions
  • Keep your commits clean.
  • when syncing your fork, consider rebasing the changes on top of yours instead of creating a merge commit for the same.
  • Make sure to update the documentation accordingly (if required).

Pull Request

  • Go to your fork and create a pull request from there.
  • Wait for it to be reviewed and merge by the maintainers/moderators.
  • Celebrate 🎉

Need help ?

You can refer to the following articles on basics of Git and Github and also don't hasitate to ask for help from project maintainers in case you face any problem or find yourself stuck somewhere in the process :