Skip to content

Commit

Permalink
Documentation Housekeeping (#51)
Browse files Browse the repository at this point in the history
* Add Code of Conduct per #18

Signed-off-by: Jonathan Hamilton <jonathan.m.hamilton@accenture.com>

* Creating Issue templates

Signed-off-by: Jonathan Hamilton <jonathan.m.hamilton@accenture.com>

* Clear historical readme info and provide new links for Rocketchat, issue templates, issue filters

Signed-off-by: Jonathan Hamilton <jonathan.m.hamilton@accenture.com>

* docs(bug_report): adds more questions about env

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
  • Loading branch information
jonathan-m-hamilton authored and petermetz committed Nov 17, 2019
1 parent 9b369e3 commit 9add091
Show file tree
Hide file tree
Showing 5 changed files with 130 additions and 246 deletions.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**

A clear and concise description of what the bug is.

**To Reproduce**

Steps to reproduce the behavior on a successfully deployed BIF cluster.

**Expected behavior**

A clear and concise description of what you expected to happen.

**Logs/Stack traces**

Can help maintainers identify root causes

**Screenshots**

If applicable, add screenshots to help explain your problem.

**Cloud provider or hardware configuration:**
Are you running the software on a dev machine or somewhere in the cloud?

**Operating system name, version, build:**

Use this command: `printf "$(uname -srm)\n$(cat /etc/os-release)\n"`

For example

```sh
$ printf "$(uname -srm)\n$(cat /etc/os-release)\n"
Linux 4.15.0-70-generic x86_64
NAME="Ubuntu"
VERSION="18.04.3 LTS (Bionic Beaver)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 18.04.3 LTS"
VERSION_ID="18.04"
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
VERSION_CODENAME=bionic
UBUNTU_CODENAME=bionic
```

**BIF release version or commit (git rev-parse --short HEAD):**

Either a semantic version of the release you are using such as `1.0.0` or a git
commit hash if you are directly working with code from the git repository.

**BIF Plugins/Connectors Used**

- Which DLT connectors are you using (Fabric, Quorum, Corda, Besu, etc.)

**Additional context**

Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

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

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/user-story-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: User Story template
about: Create a user story for BAF
title: ''
labels: ''
assignees: ''

---

### Description
As a ... I want to ... so that ....

(add more description and relevant links)

### Acceptance Criteria
1. First acceptance criteria
2. ...
3. ...
4 changes: 4 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Code of Conduct Guidelines
==========================

Please review the Hyperledger [Code of Conduct](https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct) before participating and abide by these community standards.
Loading

0 comments on commit 9add091

Please sign in to comment.