CONTRIBUTING.md

Contributing

Local Development (via symbolic links)

In order to develop against a local checkout:

1. Run yarn link in brainstem-redux
2. Run yarn compile in brainstem-redux after every change (to simulate library packaging)
3. Run yarn link brainstem-redux in the targetted project
4. Restart Webpack in the targeted project

Running example

1. Run yarn start
2. Navigate to http://localhost:8080/
3. Select the examples folder
4. View example application and type an approved string into the search bar

Publishing

As we are making changes, we should publish prerelease versions to test changes in other repositories:

1. We have a PR for some change set
2. Appropriately change the semantic version with a prerelease version
3. Publish prerelease version

Once we are ready to cut a new release:

1. Merge PR into master
2. Cut a new PR for new release
3. Appropriately change the semantic version
4. Get an approved review and passing CI suite
5. Publish new version (yarn publish)
6. Merge PR into master