Skip to content

Latest commit

 

History

History
108 lines (74 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

108 lines (74 loc) · 4.12 KB
Raw

Contributing

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Submit an Issue

Please fill the following information in each issue you submit:

  • Title: Use a clear and descriptive title for the issue to identify the problem.
  • Description: Description of the issue.
  • Steps to Reproduce: numbered step by step. (1,2,3.… and so on)
  • Expected behavior: What you expect to happen.
  • Actual behavior: What actually happens.
  • How often it reproduces?: what percentage of the time does it reproduce?
  • Version: the version of the app.
  • Repository: Link to the repository you are working with.
  • Operating system: The operating system used.
  • Additional information: Any additional to help to reproduce. (screenshots, animated gifs)

Pull Requests

  1. Fork the project
  2. Implement feature/fix bug & add test cases
  3. Run . scripts/code_quality/linter.sh
  4. Ensure test cases & static analysis runs successfully (Run . tests/run_tests.sh)
  5. Submit a pull request to master branch
  6. Include test result in the pull request. Example: img.png

Please include additional tests where necessary to cover any functionality that is introduced.

The Pull Request scheme:

  • Description: A light story telling of the changes made and why.
  • Ticket: If existing, the ticket for tracking this work.
  • Test Steps: Any special steps or info needed to test the PR. If all there is to do is run the test, just say so.
  • Run Logs: Proof the changes work and haven't broken anything.
  • Note: We should try to keep the code to under 100 lines per PR.

Coding Guidelines

Commit messages

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Footer should contain a closing reference to an issue if any.

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gradle, fastlane, npm, pypi)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Scope

The scope should be the name of the package affected (as perceived by person reading changelog generated from commit messages.

The following is the list of supported scopes:

  • core
  • library

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.