Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

42 lines (33 loc) · 1.47 KB

How to contribute?

  • Have a look at open issues. They contain the list of features we wish to implement. Pick an unassigned issue.
  • Tag the @iiitv/project-maintainers and comment on the issue stating that you would like to work on this issue.
  • The project maintainers will assign the issue on first comment first serve basis 😄
  • You can also create a new issue for a feature or a bug that is not in the list.
  • Make sure you are assigned for the issue.
  • Code the bug-fix/feature following the styleguide defined below.
  • Send a PR.
  • Be sure to not include any compiled binaries in the patch.
  • While sending a PR make sure you follow one issue per PR rule.

Commit / PR Style Guidelines

While creating a pull request (PR) keep the following guidelines in mind. It will benefit you in the long run.

Type

The type is contained within the PR title and can be one of these types:

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

Examples

  docs: added links to slack and discord channel
  fix: travis CI
  feat: added search function in getmein web

Important

  • While submitting a PR for an issue please mention 👉 Fixes #{ISSUE_NUMBER} in the body of the PR.