|
| 1 | +# Contribution guidelines |
| 2 | + |
| 3 | +We're happy to accept 3rd-party contributions. Please make sure you read this document before you do any work though, |
| 4 | +as we have some expectations related to the content and quality of change sets. |
| 5 | + |
| 6 | +## What you should know about this application |
| 7 | + |
| 8 | +This project is a template Spring Boot application. It aims to speed up the creation of new Spring APIs in HMCTS |
| 9 | +projects, by serving as the initial setup of each API. |
| 10 | + |
| 11 | +## Before contributing |
| 12 | + |
| 13 | +Any ideas on the user journeys and general service experience you may have **should be first consulted |
| 14 | +with us by submitting a new issue** to this repository. Ideas are always welcome, but if something is divergent or unrelated |
| 15 | +to what we're trying to achieve we won't be able to accept it. Please keep this in mind as we don't want to waste anybody's time. |
| 16 | + |
| 17 | +In the interest of creating a friendly collaboration environment, please read and adhere to an open source contributor's |
| 18 | +[code of conduct](http://contributor-covenant.org/version/1/4/). |
| 19 | + |
| 20 | +## Making a contribution |
| 21 | + |
| 22 | +After your idea has been accepted you can implement it. We don't allow direct changes to the codebase from the public, |
| 23 | +they have to go through a review first. |
| 24 | + |
| 25 | +Here's what you should do: |
| 26 | +1. [fork](https://help.github.com/articles/fork-a-repo/) this repository and clone it to your machine, |
| 27 | +2. create a new branch for your change: |
| 28 | + * use the latest *master* to branch from, |
| 29 | +3. implement the change in your branch: |
| 30 | + * if the change is non-trivial it's a good practice to split it into several logically independent units and deliver |
| 31 | + each one as a separate commit, |
| 32 | + * make sure the commit messages use proper language and accurately describe commit's content, e.g. *"Unify postcode lookup elements spacing"*. |
| 33 | + More information on good commit messages can be found [here](http://chris.beams.io/posts/git-commit/), |
| 34 | +4. test if your feature works as expected and does not break any existing features, this may include implementing additional automated tests or amending existing ones, |
| 35 | +5. push the change to your GitHub fork, |
| 36 | +6. submit a [pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) to our repository: |
| 37 | + * ensure that the pull request and related GitHub issue reference each other. |
| 38 | + |
| 39 | +At this point the pull request will wait for someone from our team to review. It may be accepted straight away, |
| 40 | +or we may ask you to make some additional amendments before incorporating it into the main branch. |
0 commit comments