From 9f0697dd345eff8b5505b3bdfbbac86ed73842d2 Mon Sep 17 00:00:00 2001 From: dicedtomato <35403473+diced@users.noreply.github.com> Date: Fri, 30 Sep 2022 16:16:08 -0700 Subject: [PATCH] feat: add contributing.md --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f878979 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing + +## Bug reports +Create an issue on GitHub, please include the following (if one of them is not applicable to the issue then it's not needed): +* The steps to reproduce the bug +* Logs of Zipline +* The version of Zipline +* Your OS & Browser including server OS +* What you were expecting to see + +## Feature requests +Create an issue on GitHub, please include the following: +* Breif explanation of the feature in the title (very breif please) +* How it would work (detailed, but optional) + +## Pull Requests (contributions to the codebase) +Create a pull request on GitHub. If your PR does not pass the action checks, then please fix the errors. If your PR was submitted before a release, and I have pushed a new release, please make sure to update your PR to reflect any changes, usually this is handled by GitHub. +Please make sure your code also reflects the style of the rest of the code.