Skip to content

Commit

Permalink
Update contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RobbieTheWagner committed Aug 26, 2018
1 parent 92f994d commit 8f446df
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 27 deletions.
26 changes: 5 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ You will need:
- Node.js and npm
- webpack

Windows users will need additional to setup build capabilities in NPM:
Windows users will need additional setup to enable build capabilities in NPM.
From an administrative command window:

npm install --global --production windows-build-tools
Expand All @@ -30,30 +30,14 @@ to contribute, we ask that you take the following steps:
1. Most of the _editable_ code lives in the `src` directory while built code
will end up in the `dist` directory upon running `npm run build`.

2. Depending on how big your changes are, bump the version numbers appropriately
in `package.json`. We try to follow semver, so a good rule
of thumb for how to bump the version is:
- A fix to existing code, perform a patch bump e.g. x.x.0 -> x.x.1
- New feature, perform a minor bump e.g. x.0.x -> x.1.x
- Breaking changes such a rewrite, perform a major bump e.g.
1.x.x -> 2.x.x

Versioning is hard, so just use good judgement and we'll be more than happy
to help out.

__NOTE__: There is a `npm` method that will automate some of the versioning.
You can run `npm version {type}` where type is `patch|minor|major` to
update `package.json` as well as add the appropriate git tag.

3. Provide a thoughtful commit message and push your changes to your fork using
2. Provide a thoughtful commit message and push your changes to your fork using
`git push origin master` (assuming your forked project is using `origin` for
the remote name and you are on the `master` branch).

4. Open a Pull Request on GitHub with a description of your changes.
3. Open a Pull Request on GitHub with a description of your changes.


## Testing

Work in progress. We are hoping to add some tests, so if you would like to help
us get started, feel free to contact us through the Issues or open a Pull
Request.
All PRs, that change code functionality, are required to have accompanying tests.

7 changes: 1 addition & 6 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
## v2.0.0
- Moved dependency from tether to popper.js
- Changed package name to shepherd.js on npm
-

## v1.7.0
- Fixes bug where `buttons: false` resulted in the default Next button instead of showing the desired result of no buttons.

Expand All @@ -27,7 +22,7 @@
- Exposes tour object on eager install

## v1.2.0
- Adds `showOn` for conditonally showing tour steps
- Adds `showOn` for conditionally showing tour steps

## v1.1.4
- Eager - Install helper now checks for the presence of first attach node before starting
Expand Down

0 comments on commit 8f446df

Please sign in to comment.