Skip to content

Commit

Permalink
Add GitHub templates. (#48)
Browse files Browse the repository at this point in the history
Add GitHub templates.
  • Loading branch information
winder committed Jun 18, 2019
1 parent 0d9b7c1 commit f346d3f
Show file tree
Hide file tree
Showing 5 changed files with 101 additions and 1 deletion.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,30 @@
---
name: '🐜 Bug report'
about: 'Report a reproducible bug.'
title: ''
labels: 'new-bug'
---
<!--
NOTE: If this issue relates to security, please use the vulnerability disclosure form here:
https://www.algorand.com/resources/blog/security
General, developer or support questions concerning Algorand should be directed to the Algorand Forums https://forum.algorand.org/.
-->

### 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
30 changes: 30 additions & 0 deletions .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'
---
<!--
NOTE: If this issue relates to security, please use the vulnerability disclosure form here:
https://www.algorand.com/resources/blog/security
General, developer or support questions concerning Algorand should be directed to the Algorand Forums https://forum.algorand.org/.
-->

<!--
This project is focused on low level platform concerns. A good feature request would be related
to protocol and network usage, debugging and monitoring tools, and goal commands.
Higher level suggestions relating to layer 2 applications (like wallet apps) are not appropriate here.
-->
**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.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,17 @@
---
name: '❓ Question'
about: 'General questions related to the algorand platform.'
title: ''
labels: 'question'
---
<!--
NOTE: If this issue relates to security, please use the vulnerability disclosure form here:
https://www.algorand.com/resources/blog/security
This issue tracker is not appropriate for most questions.
If your question does not involve a compiler it probably shouldn't be asked here.
General, developer or support questions concerning Algorand should be directed to the Algorand Forums https://forum.algorand.org/.
Additional information is available here: https://developer.algorand.org/
-->
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,23 @@
<!--
Thanks for submitting a pull request! We appreciate the time and effort you spent to get this far.
If you haven't already, please make sure that you've reviewed the CONTRIBUTING guide:
https://github.com/algorand/go-algorand/blob/master/CONTRIBUTING.md#code-guidelines
In particular ensure that you've run the following:
* make generate
* make sanity (which runs make fmt, make lint, make fix and make vet)
It is also a good idea to run tests:
* make test
* make integration
-->

## 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.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -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).
Expand Down

0 comments on commit f346d3f

Please sign in to comment.