Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

58 lines (38 loc) · 3.61 KB
Raw

Contributing to this repository

Getting started

Before you begin:

  • This project is made using Android (Java). Make sure you have the latest version of Android Studio and Android SDK.
  • Have you read the code of conduct?
  • Make sure to check if an issue exists already & see if the issue is assigned to anyone or not.
  • If no one is assigned you can start working on the issue.
  • Make sure to leave a comment stating that you are working on the issue.

Issue already assigned to someone? Ask before starting

If the issue is already assigned to someone, leave a comment asking how you can contribute. Please do not start working on your own without confirmation.

Don't see your issue? Open one

If you spot something new, open an issue using a template. We'll use the issue to have a conversation about the problem you want to fix.

Ready to make a change? Fork the repo

Fork using GitHub Desktop:

Fork 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.

Fork with GitHub Codespaces:

Make your update:

Make your changes to the file(s) you'd like to update.

Open a pull request

When you're done making changes and you'd like to propose them for review, open your PR (pull request). You can use the GitHub user interface for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.

Submit your PR & get it reviewed

  • Once you submit your PR, others from the Docs community will review it with you. The first thing you're going to want to do is a self review.
  • After that, we may have questions, check back on your PR to keep up with the conversation.
  • We may ask for changes to be made before a PR can be merged. You can make any other changes in your fork, then commit them to your branch.

Your PR is merged!

Congratulations! The whole community thanks you. ✨

Once your PR is merged, you will be proudly listed as a contributor in the contributor chart.

Self review

You should always review your own PR first.

For content changes, make sure that you:

  • Confirm the changes doesn't break anything else.
  • Compare your pull request's source changes to staging to confirm that the output matches the source and that everything is rendering as expected. This helps spot issues like typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems.
  • Review the content for technical accuracy.
  • Copy-edit the changes for grammar or spelling mistakes.