CONTRIBUTING.md

Contributing to these docs

The Open Data Services Developer Documentation repository conatains information we need to help us get our work done.

If you would like to contribute to it, great!

You may wish to:

• Send us feedback about the documentation. Contact details at: https://github.com/opendataservices
• Report bugs
• Request new features
• Contribute text or documents. See the list of specific tasks below.

How to report a bug or request a feature

If you are able to work with GitHub then please "Create an issue"

Before creating a new issue check to see if the issue already exists. If not then please do report it. If you have permissions to assign the issue to people and milestones then try to select suitable options.

If you are not comfortable working with GitHub, but would still like to contribute, then talk to us. Details at: https://github.com/opendataservices

How we use branches in this repository

• master represents our main development branch
• Other branches represent development work or bug fixes.

Submitting changes

• Fork this repository (if you haven't previously)
• Make sure you're working on top of an up to date copy of the master branch
  • Create a branch named after the work you're doing (if you're targeting a specific issue, start the branch name with the issue number e.g. 42-feature-name)
• Do your work
  • If your work addresses a specific issue, reference that issue in your commit message by including the URL of the issue in your message
• Create a pull request

Specific Tasks: Fix a Bitesize issue

We mark some of issues as 'Bitesize'. Generally these will help ease you into the code and help you find your way around.

Talk to us

We'd love to hear from you. Details at: https://github.com/opendataservices