Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.45 KB
Raw

Contributing

Thank you for your interest in contributing! Please feel free to put up a PR for any issue or feature request. Even if you have little to no experience with Angular, I'll be more than happy to help. :)

Setup

  1. Fork the repo
  2. Clone your fork
  3. Make a branch for your feature or bug fix
  4. If you don't have Angular CLI installed: npm install -g angular-cli@latest
  5. ng init
  6. Type n for each file to not overwrite any file changes
  7. Run ng serve and open localhost:4200 in a browser
  8. Work your magic
  9. Run ng build --prod --aot or ng serve --prod --aot to kick off a production build and make sure nothing is broken
  10. To test service worker changes:
  • ng build --prod --aot to kick off a fresh build and update the dist/ directory
  • npm run precache to generate the service worker file
  • npm run static-serve to load the application along with the service worker asset using live-server
  1. Add yourself to the contributor's list in the README!
  2. Commit your changes and reference the issue you're addressing (for example: git commit -am 'Commit message. Closes #5')
  3. Push your branch to your fork
  4. Create a pull request from your branch on your fork to develop on this repo
  5. Have your branch get merged in! 🌟

If you experience a problem at any point, please don't hesitate to file an issue or send me a message!