Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

88 lines (62 loc) · 2.57 KB

Contributing

This project adopts the following guidelines:

Spotted an bug or found something you can't otherwise fix? No worries! File an issue.

Fixed a bug, done some refactoring or wrote a new feature? Awesome! File a pull request.

Issues

  1. Search the GitHub issue tracker to see if the issue has already been reported

  2. Update your local develop to check if the issue has already been fixed

Otherwise, confirm the issue is reproducible, create a reduced test case and file a new issue with as much detail as possible.

Pull requests

We use the Git flow branching strategy, hub and git-extras. The following command line examples assume you do too (if not, the basic steps are the same)

  1. Clone and fork the project

    git clone eHealthAfrica/LMIS-Chrome
cd LMIS-Chrome
git fork

  2. Create a topic (bug/feature/refactor) branch off develop:

    git checkout --track origin/develop
git feature my-feature

  3. Write and commit some code

    • Group logical steps (Git's interactive rebase can help)
    • Make sure to maintain the project's coding style
    • Write an appropriate test case
    • Write a short (50 chars or less) commit summary and a detailed body

  4. When you're topic is finished, make sure it's up-to-date

    git pull --rebase origin develop

  5. Push it to your fork

    git push feature/my-feature [fork-remote]

  6. File a pull request

    git pull-request

A member of the team will review the request and merge it into develop if it looks good and/or discuss with you accordingly.