Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

77 lines (58 loc) · 3.45 KB
Raw

Contributing

We'd love for you to contribute to our source code and to make the project even better than it is today! Here are the guidelines we'd like you to follow:

Code of Conduct

Code of Conduct

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")

  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")

  • Limit the first line to 72 characters or less

  • Reference issues and pull requests liberally after the first line

  • When only changing documentation, include [ci skip] in the commit title

  • Consider starting the commit message with an applicable emoji:

    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing lint/checkstyle warnings

    Find all the available emojis here.

Important contribution Points:

Want to update version of a dependency?

  • change the version in buildSrc/src/main/java/Dependencies.kt
  • Change the version in app/build.gradle

Want to add a dependency?

  • Make sure that it is very common dependency and you're not adding very specifi third-party dependency that no one knows!
  • Add this dependency in respective logical Object grounp in buildSrc/src/main/Dependencies.kt
  • If you can't find a logical object group for your dependency, then create a new one and document it.
  • Add this dependency in app/build.gradle with proper comments and variable name.

Got a Question or Problem?

If you feel that we're missing an important bit of documentation, feel free to file an issue so we can help. Here's an example to get you started:

What are you trying to do or find out more about?

Where have you looked?

Where did you expect to find this information?

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our project.

To submit an issue, please check the Issue Templates.

Even better you can submit a Pull Request with a fix.

Pull Request

To generate a pull request, please consider following Pull Request Template.

  • Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
  • Please have a look at License before sending pull requests. We cannot accept code without this.

That's it! Thank you for your contribution!