Skip to content

Commit

Permalink
chore: Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sondrelg committed Apr 22, 2023
1 parent 1fe8c21 commit bfcd111
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing

Contributions are always welcome. If you would like to propose
a major change, it's probably a good idea to open an issue to discuss it first,
otherwise a PR is fine.

To submit a PR:

1. Fork the project
2. Make your changes
3. Add tests
4. Open the PR

## Running the project locally

A simple way to test things is to do create
a python file with the syntax you want to test,
then run `cargo run -- <filename>.py` to run the formatter
on it. Once you're happy with your changes you can translate
it to a test input.

0 comments on commit bfcd111

Please sign in to comment.