Skip to content

Commit

Permalink
Adding contributing guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
dherbst committed Nov 16, 2022
1 parent 63a4555 commit 12f8ef3
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# How to contribute to ratproxy

Welcome! As an open source project, contributions are welcome to help make the project better. Generally, contributions fall into the following categories:

## Bug reports
If something is not working the way you expect, or the way it was intended and needs to be fixed, please open an issue https://github.com/streamingrat/ratproxy/issues/new. Information about how to reproduce the bug is essential to ensure it is fixed as fast as possible.

## Feature Requests
If something is missing, and you really think it should be added, then open an issue https://github.com/streamingrat/ratproxy/issues/new for a Feature Request. If you plan to create a pull request and build it, please call that out in the issue.

## Questions
Not sure how something works? Ask a question by [Opening an Issue](https://github.com/streamingrat/ratproxy/issues/new).

# Pull Requests
Pull requests are welcome, and will be reviewed. If you are new to open source development there are many resources on github, and [this guide](https://github.com/freeCodeCamp/how-to-contribute-to-open-source) can be helpful with getting started.

0 comments on commit 12f8ef3

Please sign in to comment.