Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

31 lines (24 loc) · 1.3 KB
Raw

Contributing

Installation

First, ensure you have Node v10+ and the latest yarn installed on your machine.

As an external contributor, you will have to fork Peculiar Fortify Web-components to contribute code. Clone your fork onto your machine and then run the following commands to install dependencies:

git clone [email protected]:<username>/pv-certificates-viewer.git
cd pv-certificates-viewer
yarn bootstrap
yarn build

Developing

A typical contributor workflow looks like this:

  1. Create a new feature branch.
  2. Run yarn start:webcomponents in the root to watch all the code and run the dev app at http://localhost:3000.
  3. Write some code.
  4. Ensure your code is tested and linted.
    • Add unit tests as necessary when fixing bugs or adding features; run them with yarn test in the relevant packages/ directory.
    • Linting is best handled by your editor for real-time feedback. Run yarn lint to be 100% safe.
  5. Submit a Pull Request on GitHub and fill out the template.
  6. Team members will review your code and merge it after approvals.
    • You may be asked to make modifications to code style or to fix bugs you may have not noticed.
    • Please respond to comments in a timely fashion (even if to tell us you need more time).
  7. Cheers, you contributed!