Skip to content

Latest commit

 

History

History
22 lines (17 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

22 lines (17 loc) · 1.24 KB

Contributing

Thank you for your interest in contributing!

If your Hacker News implementation meets the specifications, don't hesitate to put up a PR to add its summary to HNPWA!

If you would like to file a PR to update the site's design, please file an issue for it first.

Setup

  1. Fork the repo
  2. Clone your fork
  3. Make a branch for your changes
  4. npm install
  5. npm run dev to kick off a development server
  6. To test the Service Worker locally you can run npm run dev-sw instead.
  7. If you're adding a summary of your Hacker News implementation:
    • Create a new entry under _apps with your application name
    • Fill out the list of attributes following the format of any of the other apps in the same directory (you'll need to include an image of your application in a mobile device as well)
    • Add yourself to the _contributors directory and similarly fill out all the attributes there (make sure the authors attribute underneath your app in _apps has the same exact name attribute as here)
  8. Create a pull request from your branch on your fork to master on this repo
  9. Have your branch get merged in! 🌟