diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index ff1ad599..07b2b137 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,5 +1,9 @@ # Development instructions +### Branches +The project is developed in `dev` branch. New feature or fix should come with a pull request from a fork. You can make a +pull request from either your `dev` branch or from a feature branch. + ### Running development server and watches The project contains a small demo stylesheet that can be used to develop the UI. @@ -35,13 +39,14 @@ To be able to check during development, please 1. Check that all the needed pull requests are merged 1. Make sure that your clone fetched all the tags which exist in the SC5 repo -1. Rebase your `master` branch against SC5 -1. Create `release/x.y.z` branch with the number of upcoming version and switch to it +1. Rebase your `dev` branch against SC5 +1. Create `release/x.y.z` branch from `dev` with the number of upcoming version and switch to it 1. Increment the package number in `package.json` 1. Run `gulp publish` 1. Check the `CHANGELOG.md` file. You can remove not needed items or rename them. 1. Commit changes -1. Make a pull request from your feature branch +1. Make a pull request from your feature branch into `dev` +1. Once it is merged, make a pull request from `dev` to `master` 1. Once your pull request is merged, rebase your `master` against SC5 again 1. Run `npm publish` 1. Create a versioning tag in GitHub. Insert the `CHANGELOG.md` content as a description of this versioning tag.