Skip to content
This repository has been archived by the owner on Oct 6, 2022. It is now read-only.

Latest commit

 

History

History
37 lines (27 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 2.03 KB

Contributing to the Identity SDK for Android

Code of conduct

The project is governed by the Code of Conduct, adapted from Contributor Covenant Code of Conduct. Please report any unacceptable behavior to schibstedaccount@schibsted.com

License

The Account SDK for Android is released under the MIT License. Any code submitted will be licensed under the same conditions unless explicitly stated otherwise.

Practical information

First of all, you should ensure your environment is set up in compliance with the ktlint style guide. The steps to do this, can be found over at their Github repo. In our repo, master is always the primary branch. To contribute, please make a PR against this branch from your own fork, or another branch if you have write access (which we are happy to grant to contributors).

Commit messages should clearly reflect it's changes in the format If applied, this commit will <your changes>>. Some examples include:

  • Add events hooks to the UI module
  • Fix an issue where token refreshing failed
  • Improve the logging in the AuthInterceptor class

A good example of a commit message can be found over at https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project.

Short (50 chars or less) summary of changes

More detailed explanatory text, if necessary.  Wrap it to
about 72 characters or so.  In some contexts, the first
line is treated as the subject of an email and the rest of
the text as the body.  The blank line separating the
summary from the body is critical (unless you omit the body
entirely); tools like rebase can get confused if you run
the two together.

Further paragraphs come after blank lines.

  - Bullet points are okay, too

  - Typically a hyphen or asterisk is used for the bullet,
    preceded by a single space, with blank lines in
    between, but conventions vary here