Skip to content

Latest commit

聽

History

History
46 lines (32 loc) 路 1.83 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) 路 1.83 KB
Raw

Contributing to npmhub

馃憤馃帀 First off, thanks for taking the time to contribute! 馃帀馃憤

The following is a set of guidelines for contributing. These are just guidelines, not rules, so use your best judgment and feel free to propose changes to this document in a pull request.

Code of Conduct

This project adheres to the Contributor Covenant, a code of conduct for open source projects.

be overt in our openness, welcoming all people to contribute, and pledging in return to value them as human beings and to foster an atmosphere of kindness, cooperation, and understanding.

Contributing

Projects in this organization follow the open open source contribution model:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

To get started, you'll need git and node installed.

git clone https://github.com/npmhub/npmhub
cd npmhub
npm install
npm run watch

To run the extension locally while developing:

  1. Open Chrome preferences and click "Extensions", or type chrome://extensions in the location bar.
  2. Disable the production version of npmhub if you have it installed already.
  3. Enable "Developer Mode".
  4. Click "Load Unpacked Extension".
  5. Browse to the /distribution directory of your checked-out project.
  6. Visit a Javascripty repo with dependencies and you should see dependencies listed below the README.

Deployment

Changes to the main branch are deployed automatically to the Chrome web store. Once your PR is merged, the updates should be live after a few minutes but it can sometimes take up to an hour for the Chrome web store to update.