Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

34 lines (28 loc) · 1.93 KB
Raw

How to become a contributor and submit your own code

Useful links

Doing some code

  1. If there is no issue yet: Submit an issue describing your proposed change.
  2. The repo owner will respond to your issue promptly. (This is important to keep the discussion split of the code review, but you can already start you code if you think will be accept)
  3. Fork the repo, develop and test your code changes.
  4. Don't forget to the Project CodeStyle. CI will break if you don't.
  5. Please always check the provided templates for Issues and Pull Requests, deleting what is not needed.
  6. Update the CHANGELOG.md, like illustrated below.
  7. If needed add tests and README/WIKI sessions.
  8. Submit your Pull Request

Updating CHANGELOG.md

  • Check the file CHANGELOG.md
  • Add your changes under ## [unreleased x.x.x] - following the format (Added, Changed, etc)
  • Link the issue to your changes using Small description [#XX](link_to_the_issue) where XX is the number of the issue or
  • Check previous versions for more guidance

Code Style

Path: .idea/codeStyles/ Please never change anything inside this folders

  • The file codeStyleConfig.xml should be responsible to change the kotlin lint source.
  • Please check if Android Studio right imported the Project code style.
  • After changes you can run ./gradlew ktlintFormat or the shortcuts in your touched files.

General code library rules

  • We do not use reflection without need, so avoid any :: kotlin reflection without need.
  • Documentation should always reflect the latest and best way of using the library, if is not let's fix.
  • For tests we use GIVEN/WHEN/THEN pattern