Skip to content

Commit 3371983

Browse files
seantraneseantrane
committed
chore: update repo config, docs, workflows
1 parent fb5a612 commit 3371983

33 files changed

+1299
-12444
lines changed

‎.dependabot/config.yml

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.dockerignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.dockerignore
2+
.editorconfig
3+
.env
4+
.env.*
5+
/docs
6+
/logs
7+
/temp
8+
compose.yml
9+
docker-compose.yml
10+
Dockerfile
11+
Dockerfile.*
12+
node_modules

‎.eslintrc.json

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{
2+
"env": {
3+
"browser": true,
4+
"es6": true,
5+
"jest": true
6+
},
7+
"globals": {
8+
"Atomics": "readonly",
9+
"SharedArrayBuffer": "readonly"
10+
},
11+
"ignorePatterns": [
12+
"!.*",
13+
".devcontainer/*",
14+
"**/node_modules/.*"
15+
],
16+
"parser": "@typescript-eslint/parser",
17+
"parserOptions": {
18+
"ecmaVersion": 2018,
19+
"sourceType": "module"
20+
},
21+
"plugins": [
22+
"@typescript-eslint"
23+
],
24+
"overrides": [
25+
{
26+
"files": [
27+
"*.json"
28+
],
29+
"extends": [
30+
"plugin:jsonc/recommended-with-json"
31+
],
32+
"parser": "jsonc-eslint-parser",
33+
"parserOptions": {
34+
"jsonSyntax": "JSON"
35+
}
36+
},
37+
{
38+
"files": [
39+
"*.jsonc"
40+
],
41+
"extends": [
42+
"plugin:jsonc/recommended-with-jsonc"
43+
],
44+
"parser": "jsonc-eslint-parser",
45+
"parserOptions": {
46+
"jsonSyntax": "JSONC"
47+
}
48+
},
49+
{
50+
"files": [
51+
"*.json5"
52+
],
53+
"extends": [
54+
"plugin:jsonc/recommended-with-json5"
55+
],
56+
"parser": "jsonc-eslint-parser",
57+
"parserOptions": {
58+
"jsonSyntax": "JSON5"
59+
}
60+
}
61+
]
62+
}

‎.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
name: Bug Report
3+
description: Submit a bug report
4+
title: '[Bug]: '
5+
labels: ['bug', 'triage']
6+
# assignees:
7+
# - octocat
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to fill out this bug report!
13+
- type: input
14+
id: contact
15+
attributes:
16+
label: Contact Details
17+
description: How can we get in touch with you if we need more info?
18+
placeholder: ex. [email protected]
19+
validations:
20+
required: false
21+
- type: textarea
22+
id: what-happened
23+
attributes:
24+
label: What happened?
25+
description: Also tell us, what did you expect to happen?
26+
placeholder: Tell us what you see!
27+
value: 'A bug happened!'
28+
validations:
29+
required: true
30+
- type: dropdown
31+
id: version
32+
attributes:
33+
label: Version
34+
description: What version of our software are you running?
35+
options:
36+
- 1.0.2 (Default)
37+
- 1.0.3 (Edge)
38+
validations:
39+
required: true
40+
- type: dropdown
41+
id: browsers
42+
attributes:
43+
label: What browsers are you seeing the problem on?
44+
multiple: true
45+
options:
46+
- Firefox
47+
- Chrome
48+
- Safari
49+
- Microsoft Edge
50+
- type: textarea
51+
id: logs
52+
attributes:
53+
label: Relevant log output
54+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
55+
render: sh
56+
- type: checkboxes
57+
id: terms
58+
attributes:
59+
label: Code of Conduct
60+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
61+
options:
62+
- label: I agree to follow this project's Code of Conduct
63+
required: true

‎.github/ISSUE_TEMPLATE/devops_checklist.md

Lines changed: 225 additions & 0 deletions
Large diffs are not rendered by default.

‎.github/ISSUE_TEMPLATE/epic_template.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# [Epic summary]
2+
3+
<!--- https://www.atlassian.com/agile/project-management/epics -->
4+
<!--- https://scaledagileframework.com/epic/ -->
5+
6+
<!--- Reasoning about a potential epic must be based on a definition and intent that stakeholders can agree to. The template below provides an epic hypothesis statement template that can be used to capture, organize, and communicate key information about an epic. -->
7+
8+
For [customers]
9+
who [do something]
10+
the [solution]
11+
is a [something - the "how"]
12+
that [provides the value]
13+
Unlike [competitor, current solution, or non-existing solution]
14+
our solution [does something better - the "why"]
15+
16+
## Business Outcomes
17+
18+
<!--- Measurable benefits the business can anticipate if the Epic hypothesis is proven correct. -->
19+
20+
- [ ] TBD
21+
- [ ] TBD
22+
23+
## KPI/Metrics/Targets
24+
25+
<!--- Describe all Key Performance Indicators (KPI) that the business outcome has been achieved. -->
26+
27+
- [ ] TBD
28+
- [ ] TBD
29+
30+
## Requirements
31+
32+
<!--- Describe all requirements associated with the Epic. -->
33+
34+
- [ ] TBD
35+
- [ ] TBD

‎.github/ISSUE_TEMPLATE/issue_template.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Issue Template
3+
about: A standard issue template.
4+
5+
---
6+
7+
# Description
8+
9+
Describe the issue in detail.
10+
11+
**Expected behavior:** _What you expect to happen?_
12+
13+
**Actual behavior:** _What actually happens?_
14+
15+
## Steps to Reproduce
16+
17+
1. [First Step]
18+
2. [Second Step]
19+
3. [and so on...]
20+
21+
## Versions
22+
23+
Version(s) the issue relates to, if applicable.
24+
25+
## Additional Information
26+
27+
Additional info that may help to reproduce the issue.

‎.github/ISSUE_TEMPLATE/story.yml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: Agile User Story
3+
description: Submit an issue, formatted as an Agile User Story.
4+
title: '[Story]: As a {persona}, I want {something}, so that {outcome}.'
5+
labels: ['state: pending', 'type: discussion']
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
- [How to Write Great Agile User Stories](https://sprint.ly/blog/agile-user-stories/)
11+
- [User stories with examples — Atlassian](https://www.atlassian.com/agile/project-management/user-stories)
12+
- type: input
13+
id: who
14+
attributes:
15+
label: Who are you doing this for?
16+
description: _As a {persona}._
17+
placeholder: persona
18+
validations:
19+
required: true
20+
- type: input
21+
id: what
22+
attributes:
23+
label: What are you doing?
24+
description: _I want {something}._
25+
placeholder: something
26+
validations:
27+
required: true
28+
- type: input
29+
id: why
30+
attributes:
31+
label: Why are you doing this?
32+
description: _So that {expected outcome}._
33+
placeholder: expected outcome
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: details
38+
attributes:
39+
label: Details
40+
description: Enumerate the technical details involved in playing/resolving this story.
41+
value: |
42+
- TBD
43+
- TBD
44+
validations:
45+
required: false
46+
- type: textarea
47+
id: criteria
48+
attributes:
49+
label: Acceptance Criteria
50+
description: Describe the criteria necessary to judge an acceptable outcome.
51+
value: |
52+
- [ ] TBD
53+
- [ ] TBD
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: tests
58+
attributes:
59+
label: Tests for Behavior-Driven Development (BDD)
60+
description: |
61+
Describe all scenarios, using [Gherkin syntax](https://cucumber.io/docs/gherkin/reference/), that validate your _expected outcome_.
62+
value: |
63+
```gherkin
64+
65+
Scenario: Title
66+
Given {context}
67+
And {some more context}
68+
When {event}
69+
And {another event}
70+
Then {outcome}
71+
And {another outcome}
72+
But {not this outcome}
73+
74+
```
75+
validations:
76+
required: false

‎.github/ISSUE_TEMPLATE/story_template.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# [Story summary]
2+
3+
<!--- https://www.atlassian.com/agile/project-management/user-stories -->
4+
<!--- https://sprint.ly/blog/agile-user-stories/ -->
5+
6+
_As a_ [person].
7+
8+
_I want_ [something].
9+
10+
_So that_ [action].
11+
12+
## Tech Details
13+
14+
- TBD
15+
- TBD
16+
17+
## Acceptance Criteria
18+
19+
- [ ] TBD
20+
- [ ] TBD
21+
22+
### Tests for Behavior-Driven Development (BDD)
23+
24+
<!--- Describe all scenarios that test/validated your [action]. -->
25+
<!--- This uses Gherkin syntax, common used form Cucumber-based testing. -->
26+
<!--- https://cucumber.io/docs/gherkin/reference/ -->
27+
28+
```gherkin
29+
Scenario: Title
30+
Given [context]
31+
And [some more context]...
32+
When [event]
33+
And [another event]...
34+
Then [outcome]
35+
And [another outcome]...
36+
But [not this outcome]
37+
```

0 commit comments

Comments
 (0)