Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 1.61 KB

Contributing to Covid19_EERAModel

Thanks for contributing to Covid19_EERAModel! Please read the below on how best to make progress on this project.

Pull Request Process

  1. Please branch from within ScottishCovidResponse/Covid19_EERAModel

    • Please don't fork this repository to your own github.com/username or other organisation.
  2. Read the issues and choose/be assigned an appropriate issue. This is likely to be either a Starter issue or one assigned by chatting in zulip/Covid19_EERAModel.

  3. Name the branch username/featurename and have fun!

  4. If referencing the issue from within a commit message then it should have the correct path to the issue on the ScottishCovidResponse/SCRCIssueTracking repository. An autolink reference has been created to make a shortcut; ScottishCovidResponse/SCRCIssueTracking#123 -> SCRC-123. Please put the reference in the commit description (not the first line of the commit) i.e.:

    • git commit -m "pithy description" -m "SCRC-123 and more details" to refer to issue number 123.
    • writing the commit message and description in an editor is also possible with export EDITOR=vi for example, and then just doing a git commit.
    • bash also recognises line breaks in the double inverted commas
    $ git commit -m "first line
    >
    > second line SCRC-123"
  5. When your feature is ready to merge back into the dev branch create a PR against ScottishCovidResponse/Covid19_EERAModel#dev and assign ScottishCovidResponse/eeramodel as reviewers.

  6. Semver will be handled in PRs from dev into master.

  7. Thanks for your time and effort!