Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing docs with release instructions #137

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

## Installation

- Running `npm install` in the components's root directory will install everything you need for development.
`npm install` from the components's root directory will install everything you need for development.

## Demo Development Server

- `npm start` will run a development server with the component's demo app at [http://localhost:3000](http://localhost:3000) with hot module reloading.
`npm start` will run a development server with the component's demo app at [http://localhost:3000](http://localhost:3000) with hot module reloading.

## Building

- `npm run build` will build the component for publishing to npm and also bundle the demo app.
`npm run build` will build the component for publishing to npm and also bundle the demo app.

- `npm run clean` will delete built resources.
`npm run clean` will delete built resources.

## PRs

Expand All @@ -27,3 +27,17 @@ Thanks for wanting to contribute to RCW! Here are some pull request guidelines:
- Don't forget to update readme/docs
- Ensure `npm run lint` passes
- `npm run lint -- --fix` will autofix where possible (in general, `--` passes any flags following it)

## Releasing

On a new branch (it can't be done on `master` as it is protected):

`npm version [major | minor | patch]` to bump version (use [semantic versioning](https://semver.org/))

`git push —-tags` to keep tags up to date on github

`npm publish` to release to the world! (use with `--dry-run` to test it out)

Then, push your branch as normal and open a PR to merge it into master.

`npm run gh:publish` to update the demo hosted on github pages.