Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.73 KB
Raw

Contributing to ShapeShift Web

Submitting an Issue

  • Do not open a GitHub issue if the bug you found is a security vulnerability.

    Please see ShapeShift's responsible disclosure program.

  • When contributing to ShapeShift Web, please discuss the change you want to make via a GitHub issue before making a change and submitting a PR.

Submitting a Patch

  • Open a pull request with the patch.

  • Make sure your PR description clearly describes the problem that you've solving, and how this patch achieves that goal. Include a link to the relevant GitHub issue.

  • Changes that only fix whitespace / formatting will generally not be accepted. Drive-by style fixes are fine when working on adjacent areas of the code, but please put them in a separate commit from functional changes.

  • Where possible, please provide unit tests / integration tests that demonstrate new functionality is working.

  • For all presentational components we leverage the Chakra UI with a custom theme. All of your components should be composed of Chakra UI base components. If a need arises were you need to build something completely custom. Please post in the #product-public-chat on Discord.

Getting Your PR Accepted

Our maintainers are committed to reviewing patches in a timely manner. That said, we do have other things on our plate, so please be patient.

In order to ensure high quality of the codebase, we require sign-off from at least one ShapeShift Fox. If you use GPG, feel free to sign your commits.

Once your patch has been reviewed and has been accepted, you are free to merge it.

Happy HODLing,

ShapeShift Team