-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |