See the README to get an overview of the project. Here are some helpful resources to get you comfortable with open source contribution:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters.
Contribute examples along with explanation about android topics.
You can also make a small changes such as typo, sentence fix, or a broken link.
-
Fork the repository.
-
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
-
GitHub Codespaces:
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
- Create a working branch and start with your changes!
Commit the changes once you are happy with them.
Once you are ready with your changes, don't forget to self review to quicken the review process ⚡.
When you're done making the changes, open a pull request, often referred to as a PR.
- 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.
- 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, checkout this git tutorial to help you resolve merge conflicts and other issues.