Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (36 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

69 lines (36 loc) · 2.45 KB

Contribute to CodeSearch

Commit Style Guide

A commit message consists of three parts, the title, the body and an optional footer.

Title

The title consists of the type of message and body. The type is contained within the title and can be one of these types :

  • feat: a new feature
  • fix: a bug fix
  • docs: changes to documentation
  • style: formatting, missing semicolons, etc; no code change
  • refractor: refactoring production code
  • test: adding tests, refactoring test; no production code change
  • chore: updating build tasks, package manager configs, etc; no production code change

The Subject

Subjects should be no greater than 50 characters, should begin with a capital letter and not end with a period.

Use an imperative tone for what the commit does rather than what it did, For example, use test; and not testing.

The Body

It is optional and should only be used when a commit requires a bit of explanation and context. When writing a body, the blank line between title and body is required and we should limit the length of each line to no more than 72 characters.

The Footer

The footer is optional an is used to reference issue tracker IDs, for example: fixes: #71

Issue tracker guide

Please submit issues in the following format :

  • Summary: Summarize your issue in one sentence(what goes wrong, what did you expect to happen)

  • Steps to reproduce: How can you reproduce the issue?

  • Expected behaviour: What did you expect the app to do?

  • Observed behaviour: What did you see instead? Describe your issue in detail here

  • Device and Android Version: What make and model device did you encounter this on? What is the Android version? For example: Lenovo K4 Note, Android 6.0

  • Screenshots: Can be made by pressing the volume down and home button in Android 4.0 or higher

  • Possible fixes: If you can link to the line of code that might be responsible for the problem.

Pull request guide

Please submit the pull requests with the fix or improvements

  • Fork the repository on Github

  • Create a feature branch(optional)

  • Write code

  • If you have multiple commits please squash them into one commit. See this article for instructions.

  • Please follow the commit message guidelines before submitting the PR.

  • Push the commit to your fork.