Contributing
Want to contribute? Great! First, read this page
Filing issues
In your issue, make sure to include the following items:
- Add a descriptive title, e.g. include package name, search term or the specific error label from the analysis tab.
- URL of the page you are reporting something (using the "Report an issue" link on the page does this).
- Screenshot of the page (if relevant).
- The device you are using (if relevant).
Before you contribute code
Before you start working on a larger contribution, you should get in touch with us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on.
Code reviews
All submissions, including submissions by project members, require review. We recommend forking the repository, making changes in your fork, and sending us a pull request so we can review the changes and merge them into this repository. Note that this package doesn't use the Dart formatter. The reviewer will reformat your code themselves if necessary.
Functional changes will require tests to be added or changed. The tests live in
the test/ directory, and are run with pub run test. If you need to create
new tests, use the existing tests as a guideline for what they should look like.
Before you send your pull request, make sure all the tests pass! Just run
pub run test.
Forking and Cloning Repo
- Fork the project.
- Click on the "Code" button on the Repo page.
- Copy the URL for the forked Repo "https://github.com/your-github-username/chance-dart.git"
- Open your Code Editor and run
git clone"https://github.com/your-github-username/chance-dart.git"
Add "Remote To" and "Pull From" Upstream
- Add a Remote to Upstream to your Repo:
Using the command :
git remote add upstream"https://github.com/your-github-username/branch-name" - Pull from upstream to download all changes in the project using
git pull upstream develop
Check issues available
Before contributing:
- You should check the list of issues available
- Note down the issue number you are interested in
- The issue number will be needed when making PR
Complete assigned task/issue
- Open the project in your IDE or Code Editor.
- Complete your assigned task.
Create and Commit Changes to a New Branch
When your task is completed:
- Create a new branch with your task name e.g "feat- UpdatedDocs".
- run:
git checkout -b feat/yourTaskPush to github; git add .git commit -m "feat: Inplemented yourTask"