diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md new file mode 100644 index 0000000..ae75a01 --- /dev/null +++ b/templates/CONTRIBUTING.md @@ -0,0 +1,64 @@ +# Contributing to SciTools + +Thank you so much for taking the time to contribute! + +We want to be driven by the community - your +contributions are invaluable to us! This page lists the guidelines +for contributors which will help ease the process of getting your hard work accepted +into , and shared with the world. + + +## Table of Contents DONE +- Code of Conduct DONE +- Relevant Links DONE +- Setting Up +- Running Tests +- Submitting Changes +- Style Guide +- Reporting Bugs +- Where to Start? +- Getting Help + +## Code of Conduct +See our CODE_OF_CONDUCT.md + +## Relevant Links +(GitHub)[https://github.com/SciTools/] +(Documentation)[] + +## Setting Up + + +- Setting up a development env. +- Where is the file? +- Custom configurations + +## Testing +Where are the tests? +How do you test? +- Graphics +- Skips +CML? + +## Submitting Changes +- Branching strat +- PRs + - review policy + - self-merging is fine for inconsequential PRs ONLY. Things like typos etc. Anything else needs a full review + - We review PRs regularly. If we haven't gotten to yours yet, please bear with us, we will! + +## Reporting a Bug +- Create an isse on GitHub/ + +## Where to start? +- Good first issues. + +## Style guide/conventions +- pre-commit +- Here's how you get pre-commit on your environment +- Linting is ruff etc + +## Where can I ask for help? +- Discussions + +Thanks again! \ No newline at end of file