registers-react-library/CONTRIBUTING.md

A library of React components for ONS registers projects, using the external ONS pattern library.

Contributing guidelines
=======================

### Git workflow

* We use git-flow - create a feature branch from `develop`, e.g. `feature/new-feature`
* Pull requests must contain a succinct, clear summary of what the user need is driving this feature change
* Ensure your branch contains logical atomic commits before sending a pull request - follow the [alphagov Git styleguide](https://github.com/alphagov/styleguides/blob/master/git.md)
* You may rebase your branch after feedback if it's to include relevant updates from the develop branch. We prefer a rebase here to a merge commit as we prefer a clean and straight history on develop with discrete merge commits for features

### Javascript Style

* We use the [Airbnb React/JSX Style Guide](https://github.com/airbnb/javascript)
* To use linting as you write code, find the correct [ESLint add-on](http://eslint.org/docs/user-guide/integrations) for your editor

### Storybook

* If you add a new component, add a coresponding 'story' in `./src/stories`
* Documentation can be found [here](https://github.com/storybooks/storybook)

### Testing

* All components should have their own tests
* Add your tests to `src/__tests__`
* The tests use [Enzyme](https://github.com/airbnb/enzyme)