Skip to content

Commit d1d4ecb

Browse files
authored
Create CONTRIBUTING.md
1 parent a9b9514 commit d1d4ecb

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing! Please feel free to put up a PR for any issue or feature request.
4+
Even if you have little to no experience with Angular, We'll be more than happy to help. :)
5+
6+
## Setup
7+
8+
1. Fork the repo
9+
2. Clone your fork
10+
3. Make a branch for your feature or bug fix
11+
4. If you don't have Angular CLI installed: `npm install -g angular-cli@latest`
12+
5. `ng init`
13+
6. Type `n` for each file to not overwrite any file changes
14+
7. Run `ng serve` and open `localhost:4200` in a browser
15+
8. Work your magic
16+
9. Run `yarn build:prod` to kick off a production build and make sure nothing is broken
17+
10. To test service worker changes:
18+
* `yarn build:prod` to kick off a fresh build and update the `dist/` directory
19+
11. Add yourself to the [contributor's list](https://github.com/aviabird/angularspree#contributors) in the README!
20+
12. Commit your changes and reference the issue you're addressing (for example: `git commit -am 'Commit message. Closes #5'`)
21+
13. Push your branch to your fork
22+
14. Create a pull request from your branch on your fork to `master` on this repo
23+
15. Have your branch get merged in! :star2:
24+
25+
If you experience a problem at any point, please don't hesitate to file an issue or send me a message!

0 commit comments

Comments
 (0)