Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 2.38 KB

Contributing

Thanks for your interest in contributing to the Quarto NHS theme.

The NHS-R Community welcomes contributions in the form of bug fixes and improvements.

Contributing workflow

If you're new to Github and/or Markdown, Github's own contributor's guide provides a good overview of these topics.

To contribute:

  • Review the issue list, raise an issue if required
  • Fork this repository
  • Make changes or add new scripts
  • Commit and push to your own repository
  • Create a new pull request detailing your additions
  • Wait for pull request to be reviewed, and merged (not everyone will have permission to merge pull requests)
  • Celebrate your first step into the open source world and contribute more

Using issues

If you spot something that needs to be changed, or would like to suggest some new content, please raise an issue.

Before raising a new issue, have a look through the existing ones in case it's already been raised.

Pull requests and merging

If you have a change (or a new page) to raise, please create an issue first as there may be someone thinking of contributing something similar.

You can't push to the main branch. For all changes you will need to create a fork, and then a pull request (click compare across forks and select your version).

Please reference the issue the pull request resolves, so it will be closed automatically.

Contributing guidelines and etiquette

  • Preview your Markdown code to make sure the format is not broken.
  • Material, including commit messages, should be written in clear and simple English.
  • Check grammar, spelling and punctuation.
  • Nothing included should be confidential, private or disclose any personal or sensitive data.
  • New directories should be created for each new demo or collection of related how-tos.
  • Follow the code of conduct at all times

When contributing any additions, the contributor certifies that they are the author, or has cited the author and is authorised to reuse/reference the material

Acknowledgements

This contributing guide is adapted from NHS Digital's Contributor's Guide.