diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f3e86e0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing to BonkeyWonkers + +1. All contributions must pass built in checks. + A. you can test the majority by running `pre-commit -a` before submitting the + PR. +2. All contributions should leverage open source tools. +3. Contributions should be tested in `Code Spaces` to make sure that all previous + contributions still work. +4. If you add an exercise add the setup for `Code Space` to insure it works on launch. +5. New exercises should have a README.md file in the new folder. + A. The README.md should be linked to from the README.md in the root of the repo. + B. The README.md should have a link to the previous exercise. + C. The README.md should explain the exercise and steps to be performed when + doing it.