Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 40 lines (20 sloc) 1.018 kb
4377501 @laktek Added CONTRIBUTING file
authored
1 ## Follow this flow to fix bugs, implement new features for Punch:
2
3 1. Fork [Punch on GitHub](http://github.com/laktek/punch):
56a0c2c @laktek Updated contributing document
authored
4
4377501 @laktek Added CONTRIBUTING file
authored
5 2. Clone the forked repository:
56a0c2c @laktek Updated contributing document
authored
6
4e3db7d @laktek Refactored how nested and wildcard bundles are fetched. Fixes #28
authored
7 git clone git@github.com:YOUR_USER/punch.git && cd punch
56a0c2c @laktek Updated contributing document
authored
8
475b84b @laktek Upated contributing guide
authored
9 3. Install the development version of the package, along with the dependencies.
56a0c2c @laktek Updated contributing document
authored
10
4e3db7d @laktek Refactored how nested and wildcard bundles are fetched. Fixes #28
authored
11 npm link
56a0c2c @laktek Updated contributing document
authored
12
475b84b @laktek Upated contributing guide
authored
13 4. Verify existing tests pass:
56a0c2c @laktek Updated contributing document
authored
14
4e3db7d @laktek Refactored how nested and wildcard bundles are fetched. Fixes #28
authored
15 npm test
56a0c2c @laktek Updated contributing document
authored
16
d2bf140 @laktek Enabled JSHint code complexity options
authored
17 5. Read the [Code Style Guide](https://github.com/laktek/punch/wiki/Code-Style-Guide).
56a0c2c @laktek Updated contributing document
authored
18
475b84b @laktek Upated contributing guide
authored
19 6. Create a topic branch:
20
4e3db7d @laktek Refactored how nested and wildcard bundles are fetched. Fixes #28
authored
21 git checkout -b feature
475b84b @laktek Upated contributing guide
authored
22
23 7. **Make your changes.** (It helps a lot if you write tests first.)
56a0c2c @laktek Updated contributing document
authored
24
475b84b @laktek Upated contributing guide
authored
25 8. Verify that tests still pass:
56a0c2c @laktek Updated contributing document
authored
26
4e3db7d @laktek Refactored how nested and wildcard bundles are fetched. Fixes #28
authored
27 npm spec
56a0c2c @laktek Updated contributing document
authored
28
475b84b @laktek Upated contributing guide
authored
29 9. Run JSHint to make sure you're code didn't introduce any inconsistencies:
56a0c2c @laktek Updated contributing document
authored
30
4e3db7d @laktek Refactored how nested and wildcard bundles are fetched. Fixes #28
authored
31 jshint lib/*
56a0c2c @laktek Updated contributing document
authored
32
475b84b @laktek Upated contributing guide
authored
33 10. Push the changes to your fork:
56a0c2c @laktek Updated contributing document
authored
34
4e3db7d @laktek Refactored how nested and wildcard bundles are fetched. Fixes #28
authored
35 git push -u YOUR_USER feature
56a0c2c @laktek Updated contributing document
authored
36
475b84b @laktek Upated contributing guide
authored
37 11. Send a [pull request](https://github.com/laktek/punch/pulls) describing your changes.
56a0c2c @laktek Updated contributing document
authored
38
475b84b @laktek Upated contributing guide
authored
39 12. If possible, check whether the [Punch Guide](https://github.com/laktek/punch/wiki) is still up to date, after merging your changes.
Something went wrong with that request. Please try again.