Skip to content

Commit

Permalink
Add contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
rgrove committed Dec 30, 2024
1 parent 45dbeac commit 859c3aa
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 @@
# Contributing to Sanitize

Contributions are welcome!

Sanitize is a mature project, and our primary focus is ensuring stability and security while keeping the maintenance burden low. Before you spend time on a contribution, please read the following guidelines.

- Bug fixes are always appreciated!

- New features and major changes are unlikely to be accepted. Please keep this in mind before spending significant time on something.

- Please include unit tests for all changes.

At this time, we're not interested in contributions that expand the included default, basic, relaxed, or restricted configs.

While we may improve the included configs from time to time, they're primarily intended to serve as examples or baselines on which users can base their own custom configs. If you have a need that isn't met by these configs, the best thing to do is to create a custom config for your own use.

0 comments on commit 859c3aa

Please sign in to comment.