Thank you for showing interest in contributing to this project! You're awesome!
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
#TODO CHANGE-ME REVIEW-ME
The ??CHANGE-ME?? project is made of... REVIEW-ME
There are a lot of ways one can contribute to this project, like reporting and solving issues, submitting new features,
making UI and code improvements, and contributing with custom computing methods.
To get an overview of the project, read the [README](../README.md). Here are some resources to help you get started with open source contributions:
- [Finding ways to contribute to open-source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
#TODO CHANGE-ME REVIEW-ME
First of all, you must read our Code of Conduct, after that you can decide how you want to contribute to the project, if you want to contribute with the mobile application or the inertial device you should take your time to read and understand comprehensively the Project Architecture, however, if you want just to contribute with custom computing methods, you just need a basic understanding of Dart and to keep reading this guide. To get started with your environment, read the installation guide.
if you feel ready after those readings, then first and foremost choose or open an issue to work on.
#TODO CHANGE-ME REVIEW-ME
Take a couple of minutes to search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form. There will be some options for you to choose then you can follow the guidelines provided on the template, make sure to read it all, and don't be afraid to send it. If you want to submit new computing methods, open an issue as a feature request.
#TODO CHANGE-ME
Scan through our existing issues to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
#TODO CHANGE-ME
#### Making changes in the ???CHANGE-ME??? part? section?
#### Making changes in the ???CHANGE-ME??? architecture?
#TODO CHANGE-ME REVIEW-ME
Commit the changes once you are happy with them. Be short and precise with your commit messages, read this Free Code Camp article for some guidance in that matter.
Once your changes are ready, don't forget to self-review and test your own changes to speed up the review process.
#TODO CHANGE-ME REVIEW-ME
When you're finished with the changes, create a pull request, also known as a PR.
- Fill in the template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, check out this git tutorial to help you resolve merge conflicts and other issues.
#TODO CHANGE-ME REVIEW-ME
Congratulations 🎉🎉
The team thanks you ✨. Welcome aboard.