Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

60 lines (45 loc) · 2.27 KB
Raw

Contribution Guidelines

Setting up user information

Please, have Git set up with consistent user information before commiting. Preferably, provide your real name and a working email address.

Example:

git config --global user.name "Your Name Comes Here"
git config --global user.email [email protected]

Use the Gitflow workflow

We follow the Gitflow workflow using a master branch:

  • master: collection branch for small fixes (one liner) and merge target for bigger fixes, enhancements and new features separated in distinct branches

All fixes, enhancements and new features are stored in distinct branches named by their type and a short descriptive name:

  • fix
  • enhancement
  • feature

Examples:

  • fix-report-layout
  • enhancement-code-reviews
  • feature-new-taxonomic-classification

Make sure that your branch contains clean commits

  • Follow the common sense guidelines for writing good commit messages (see below).
  • Make separate commits for separate changes. If you cannot describe what the commit does in one sentence, it is probably a mix of changes and should be separated into several commits.
  • Do not merge master into your branch. Use git rebase if you need to resolve merge conflicts or include the latest changes.

Check your coding style

  • Make sure your contributions and changes follow the coding and indentation style of the code surrounding your changes.
  • Do not commit commented-out code or files that are no longer needed. Remove the code or the files unless there is a good reason to keep it.

Guidelines for good commit messages

  1. Separate subject from body with a blank line
  2. Use the imperative mood in the subject line ("Fix", "Add", "Change" instead of "Fixed", "Added", "Changed")
  3. Limit the subject line to 50 characters
  4. Reference an issue in the beginning of a subject line
  5. Do not end the subject line with a period
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

Bad:

Some changes fixing this and that...

Good:

#123 Fix broken resistance model link in ABR reports

As CARD changed some of their website structure we need to update link templates for antibiotic resistance (ABR) models.

Helpful Sources