diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..ef3b9bc7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,13 @@ +One line summary of the issue here. + +### Expected behavior + +As concisely as possible, describe the expected behavior. + +### Actual behavior + +As concisely as possible, describe the observed behavior. + +### Steps to reproduce the behavior + +Please list all relevant steps to reproduce the observed behavior. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 98622e9e..7f67489b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,6 +62,26 @@ locally). We generally follow [Effective Scala][es] and the [Scala Style Guide][ssg]. When in doubt, look around the codebase and see how it's done elsewhere. +## Issues + +When creating an issue please try to ahere to the following format: + + One line summary of the issue (less than 72 characters) + + ### Expected behavior + + As concisely as possible, describe the expected behavior. + + ### Actual behavior + + As concisely as possible, describe the observed behavior. + + ### Steps to reproduce the behavior + + List all relevant steps to reproduce the observed behavior. + +## Pull Requests + Comments should be formatted to a width no greater than 80 columns. Files should be exempt of trailing spaces.