Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

36 lines (22 loc) · 1.21 KB
Raw

HOW TO CONTRIBUTE

Fearch is in its very early development stage, you can go over the issues on the github
issues page and send in a PR.

Your commits in the PR should be of the form:

shortlog: commit message

commit body

Fixes #21

  1. shortlog is the area/filename where you make the change. Example popup.js: Added warning messages

  2. commit message is a very brief description of the change made by you.

Use the imperative mood in the commit message. Imperative mood just means "spoken or written as if giving a command or instruction". A few examples:

  • Add CONTRIBUTING.MD instead of Adding CONTRIBUTING.md
  • Change the header text format instead of Changing the header text format
  • Fix text box scaling instead of Fixing the text box scaling

Also never use a full stop towards the end of the commit message.

  1. commit body contains all the additional or extra details about the commit.

The commit body need not have imperative mood you have independence to explain everything normally
there. Also here you are free to use all punctuations, also a full stop towards the end.

  1. The Fixes #< issue_no > is the issue you are working on.

Happy coding :)