Thanks for taking you time to contribute to this repo. Before you start contributing please go through the following guidelines which we consider are important to maintain this repository and can help new contributers to open source.
-
Before you submit a Pull request ensure a issue exist describing the issue/feature request. If it doesn't please file an issue so that we could discuss about the issue before the actual PR is submitted. It helps to avoid any confusion and helps to maintain the quality of the code.
-
When filing an issue ensure sufficient information is added to explain the bug/feature request and a possible solution/ proposal for the same. This helps to understand the issue better and helps to resolve the issue faster.
-
We appreciate any contribution, from fixing a grammar mistake in a comment, improving code snippets to fixing a bug or making a feature requests and writing proper tests are also highly welcome.
-
Follow the best typescript practices to maintain the quality of code.
(Optional)
- Additional changes for publishing a release. Update the version in readme, pubspec.yaml, and update the changelog. Make sure the documentation is updated as per the changes. Make sure existing and new tests are passing. Make sure the code is well formatted. Ensure the linter warnigs are zero.
- Fork This repo
- Create a new branch
- Commit a Fix/Feature Request
- Submit a PR referencing the issue
- Request a review
- wait for LGTM 🚀 comment