Skip to content

Commit

Permalink
Add contributor guide from pyproject-template (#159)
Browse files Browse the repository at this point in the history
Fixes #150
  • Loading branch information
amyreese authored Aug 2, 2023
1 parent 25f832b commit fc3397f
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing to µfmt

## Setup

Create a fresh development enviroment, and install the
appropriate tools and dependencies:

$ make venv
$ source .venv/bin/activate


## Validate

With the virtualenv activated, run the tests and linters:

$ make test lint


## Submit

Before submitting a pull request, please ensure
that you have done the following:

* Documented changes or features in README.md
* Added appropriate license headers to new files
* Written or modified tests for new functionality
* Used `make format` to format code appropriately
* Validated and tested code with `make test lint`

0 comments on commit fc3397f

Please sign in to comment.