Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.18 KB
Raw

How to contribute

Thank you for your interest in contributing to this project.

Contribution should be easy with small guidelines you need to follow. We would love to accept your pull requests to this project by raising an issue in the issue list or picking an existing issue.

The issue clearly explains about the new or enhanced feature, or a bug fix. Please follow these simple guidelines here.

How to submit a Pull Request i.e. the change you want to merge

e.g. The below commit message start with an issue number e.g. ISSUE-14, Then a space, then #, then a space, then a short commit message max of 70 chars. e.g.

ISSUE-14 # SSL enabled http client

  1. Best to start with opening a new issue describing the feature or a bug fix you intend to be available in the framework.

  2. Follow the usual process of forking the repo to work in.
    Make sure you dont add any other feture or code which are not related to this issue. This makes things clear for reviewer and a great time saver.

  3. Cover your feature or bug fix code by good tests which are easy to understand. The project has already good amount of unit and integration test coverage, so please refer some of the existing tests if you are unsure how to go about it.

  4. Please maintain well-formed-ness and consistency for each commit. Avoid including any special chars in the commit messages. Do not make it verbose.

  5. Finally, push the commits to your fork and submit a pull request.

  6. Please join our mailing-lists and gitter chat room for seeking community help.

Note

Any contribution submitted by an author for inclusion in this repository shall be licensed under this LICENSE