Skip to content

Commit

Permalink
Add contributing file
Browse files Browse the repository at this point in the history
  • Loading branch information
sanders41 committed Jan 12, 2024
1 parent 89b7803 commit a740d84
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 @@
Thank you for your interest in contributing to the Rust In Pieces!

There are a few ways of helping: critiquing the documentation and/or code examples, fixing
incorrect information, and fixing bugs.

It is encouraged for you to run the tests, formatters, and linters before submitting PRs. They will
all need to pass before the PR can be merged so you can save youself some time by running them
locally before submitting.

## Critiquing the documentation and/or code

This is the easiest way to contribute. Basically, as you read the documentation or experiment with
the code samples, if you find something confusing, incorrect, or missing, then you can file an
[issue](https://github.com/thedataquarry/rustinpieces/issues) explaining your concerns.

## Fixing incorrect information

If you find typos or incorrect links we welcome PRs to fix them. For these types of fixes there is
no need to open an issue first. For larger changes you are encouraged to first open an issue to
discuss the change before taking the time to make changes.

## Fixing bugs

If you find a bug in the code examples as you work through them, PRs for fixes are welcome. When
fixing a bug in either a Python or Rust file please check the other language's corresponding file
to see if the same bug exists there. If you now how to fix both then you can do both in one PR. If
you are unsure how to make the fix in one language let us know in your PR description so we can make
the additional fix.

0 comments on commit a740d84

Please sign in to comment.