Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

74 lines (48 loc) · 3.35 KB
Raw

Contributing to the Afterpay Android SDK

Bug Reports, Feature Requests and Questions

Before submitting a new GitHub issue, please make sure to:

  • Read the README for this repo.
  • Read other documentation in this repo.
  • Search the existing issues for similar issues.

If the above doesn't help, please submit an issue via GitHub.

Contributing Code

Checking out the Code

Recommended

  • Create a new branch to work on with git checkout -b <YOUR_BRANCH_NAME>.
    • Branch names should be descriptive of what you're working on, eg: docs/updating-contributing-guide, fix/create-user-crash.
  • Use good descriptive commit messages when committing code.

Testing

  • Please write unit tests for your code changes.
  • Run the unit tests with ./gradlew test or in Android Studio before submitting your Pull Request.

Submitting a Pull Request

When you are ready to submit the PR, everything you need to know about submitting the PR itself is inside our Pull Request Template. Some best practices are:

  • Use a descriptive title.
  • Link the issues that are related to your PR in the body.

After the review

Once a Code Owner has reviewed your PR, you might need to make changes before it gets merged. To make it easier on us, please make sure to avoid amending commits or force pushing to your branch to make corrections. By avoiding rewriting the commit history, you will allow each round of edits to become its own visible commit. This helps the people who need to review your code easily understand exactly what has changed since the last time they looked.

When you are done addressing your review, make sure you alert the reviewer in a comment or via GitHub's rerequest review command. See GitHub's documentation for dealing with Pull Requests.

After your contribution is merged, it will not be immediately available to all users. Your change will be shipped as part of the next release.

Code of Conduct

Help us keep this project diverse, open and inclusive. Please read and follow our Code of Conduct.

Thanks for Contributing!

Thank you for taking the time to contribute to the project!

License

This project is licensed as per the LICENSE file.

All contributions to this project are also under this license as per GitHub's Terms of Service.