Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 2.01 KB

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Best Practices

There are several coding practices that are applied to all adapters, for code readability, code consistency, and bug avoidance purposes. Please keep these in mind when making adapter modifications:

  1. All adapters should be formatted using Google Style. Download the intellij-java-google-style.xml file and import it to Android Studio by going to Settings > Editor > Code Style and select Scheme > Import Scheme. Once this is imported, you can reformat your code by going to Code > Show Reformat File Dialog and click Run. Make sure that Rearrange code is not selected to avoid large diffs.

If you can't become a contributor

If you can't become a contributor, but wish to share some code that illustrates an issue / shows how an issue may be fixed, then you can attach your changes on the issue tracker. We will use this code to troubleshoot the issue and fix it, but will not use this code in the library unless the steps to submit patches are done.