Skip to content

Commit

Permalink
Add CONTRIBUTING.md file.
Browse files Browse the repository at this point in the history
  • Loading branch information
pazguille committed Mar 8, 2015
1 parent 93735d2 commit 3e8b8e8
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing

## Code style
Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**

## Modifying the code

Please don't edit `/dist/slideout.js` and `/dist/slideout.min.js` files. You'll find source code in the `index.js` file.

1. Fork and clone the repo.
2. Run `npm install` to install all dependencies.
3. Create a new branch, please don't work in your `master` branch directly.
4. Open the file `/test/index.html`.
5. Code!

### Running the tests

- Run `npm test` from your command line and check the console
- Open the `/test/index.html` file to run test in your browser.

## Pull requests

1. Create a new branch, **please don't work in your `master` branch directly**.
2. Code!
3. Update the tests and run `npm test` to see the tests.
4. Run `npm run hint`.
5. Run `npm run dist` to build a new version.
6. Update the documentation and package to reflect any changes.
7. Push to your fork and submit a pull request.

0 comments on commit 3e8b8e8

Please sign in to comment.