diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..c709eff1c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: '🐜 Bug report' +about: 'Report a reproducible bug.' +title: '' +labels: 'new-bug' +--- + + +### Subject of the issue +Describe your issue here. + +### Your environment +* Software version: `algod -v` +* Node status if applicable: `goal node status` +* Operating System details. +* In many cases log files and cadaver files are also useful to include. Since these files may be large, an Algorand developer may request them later. These files may include public addresses that you're participating with. If that is a concern please be sure to scrub that data. + +### Steps to reproduce +Tell us how to reproduce this issue. + +### Expected behaviour +Tell us what should happen + +### Actual behaviour +Tell us what happens instead diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..3ad2519657 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,30 @@ +--- +name: '🔔 Feature Request' +about: 'Suggestions for how we can improve the algorand platform.' +title: '' +labels: 'new-feature-request' +--- + + + +**Is your feature request related to a problem? Please describe.** + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** + +A clear and concise description of what you want to happen. + +**Additional context** + +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000000..bab0d9df73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,17 @@ +--- +name: '❓ Question' +about: 'General questions related to the algorand platform.' +title: '' +labels: 'question' +--- + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..f4c962c611 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ + + +## Summary + +Explain the goal of this change and what problem it is solving. + +## Test Plan + +How did you test these changes? Please provide the exact scenarios you tested in as much detail as possible including commands, output and rationale. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18591da8b7..e9080e1056 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,7 @@ Again, if you have a patch for a critical security vulnerability, please use our For Go code we use the [Golang guidelines defined here](https://golang.org/doc/effective_go.html). * Code must adhere to the official Go formatting guidelines (i.e. uses gofmt). -* We use **gofmt** and **golint**. Also make sure to run `make fix` and `make generate` before opening a pull request. +* We use **gofmt** and **golint**. Also make sure to run `make sanity` and `make generate` before opening a pull request. * Code must be documented adhering to the official Go commentary guidelines. For JavaScript code we use the [MDN formatting rules](https://developer.mozilla.org/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/JavaScript).