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.
- Have you read the code of conduct ?
- Check out the existing issues & see if we accept contributions for your type of issue.
- Project Conventions
- Find an issue/potential feauture
- Labels
- Work on the issue assigned
- Pull Request
- Additional help
- All the explicit widget created must go inside lib folder, in a new file or an existing dart file.
- All the styles that are implemented would go into separate file NOT inline.
- 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 ).
- All kinds of issues are accepted as far as they're relevant and are enhancing app's quality, features, speed, design or making the documentation better or are related to website for zanie.
- Take a look at the Existing Issues or create your own Issue.
- Show your interest by commenting on the issue you want to work on and the maintainers will assign you the issue.
Labels can help you find an issue you'd like to help with.
- The
help wantedlabel is for problems or updates that anyone in the community can start working on. - The
good firstissue label is for problems or updates we think are ideal for beginners.
- Make sure the changes follow our Project Conventions
- Keep your commits clean.
- Make sure to update the documentation accordingly (if required).
- Go to your fork and create a pull request from there.
- Wait for it to be reviewed and merge by the maintainers/moderators.
- Celebrate 🎉
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 :