Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.62 KB

Contributing to PWA Shields

The following document outlines what you need to know in order to contribute to PWA Shields in order to comply with our standards and to create a quality software product.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Issue Tracker

The issue tracker is the preferred way for adding bugs, feature requests, and submitting pull requests. Please tag the issue with the appropriate label(s). Currently we use the default labels provided by Github, but are open to suggestions to change this.

Contribution Process

  1. Determine a current unassigned issue or new issue that you would like to work on. If it is a new issue, please create the issue and tag appropriately. Once you determine what you'd like to work on, assign the issue to you.

  2. Create a branch off of production using the project name & issue number. Example: pwa-shields-issue-1

  3. Complete the issue making sure that the issue is 100% finished and does not break other parts of the code.

  4. Submit a PR into the production branch for review within the issue.

Figma

If the issue you are working on involves modifying or creating new logos or shields, please comment in the issue tagging richardtaylordawson in order to get access to the Figma file.

License

By contributing your code, you agree to license your contribution under the MIT License.