Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 3.5 KB

Contributing

Contributions of all types are welcome. We use GitHub as our bug and feature tracker both for code and for other aspects of the library (documentation, the wiki, etc.).

Asking Questions

The best way to ask general questions is to send an email to our mailing list, or join #glide-library on freenode.org.

Filing issues

When in doubt, file an issue. We'd rather close a few duplicate issues than let a problem go unnoticed. Similarly if you support a particular feature request, feel free to let us know by commenting on the issue or subscribing to the issue.

To file a new issue, please use our issue template and fill out the template as much as possible (remove irrelevant parts). The more information you can provide, the more likely we are to be able help.

Contributing code

Pull requests are welcome for all parts of the codebase, especially the integration libraries. You can find instructions on building the project in README.md. Our code style is defined in Intellij project files in the repo and also by our Checkstyle config. If you'd like to submit code, but can't get the style checks to pass, feel free to put up your pull request anyway and we can help you fix the style issues. If you'd like to contribute code, you will need to sign Google's individual contributor license agreement which will be asked when you create the PR by googlebot should you forget it.

Labels

Labels on issues are managed by contributors, you don't have to worry about them. Here's a list of what they mean:

  • bug: feature that should work, but doesn't
  • enhancement: minor tweak/addition to existing behavior
  • feature: new behavior, bigger than enhancement, it gives more bang to Glide
  • question: no need to modify Glide to fix the issue, usually a usage problem
  • reproducible: has enough information to very easily reproduce, mostly in form of a small project in a GitHub repo
  • repro-needed: we need some code to be able to reproduce and debug locally, otherwise there's not much we can do
  • duplicate: there's another issue which already covers/tracks this
  • wontfix: working as intended, or won't be fixed due to compatibility or other reasons
  • invalid: there isn't enough information to make a verdict, or unrelated to Glide
  • non-library: issue is not in the core library code, but rather in documentation, samples, build process, releases
  • v4: problem originated in v4, or question about v4 (while v3 is in wide use)

bug + enhancement: feature that doesn't work, but it's an edge case that either has a workaround or doesn't affect many users