Skip to content

Commit 35c10c7

Browse files
Simplify github templates
1 parent a6540e9 commit 35c10c7

File tree

4 files changed

+21
-46
lines changed

4 files changed

+21
-46
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,36 @@ assignees: ''
77

88
---
99

10-
Please replace every line in curly brackets { like this } with an appropriate answer, and remove this line.
11-
1210
## Description
1311

14-
{ Please provide a clear and concise description of the bug. }
1512

1613
## Environment
1714

18-
1. OS (where TypeDB server runs): { e.g. Mac OS 10, Windows 10, Ubuntu 16.4, etc. }
19-
2. TypeDB version (and platform): { e.g. TypeDB 1.4, or TypeDB Cluster 1.4.3 on Google Cloud }
20-
3. TypeDB driver: { e.g. driver-java, driver-python, driver-nodejs, driver-rust, or console }
21-
4. Other environment details:
15+
1. TypeDB distribution: Core/Enterprise/Cloud
16+
2. TypeDB version:
17+
3. Environment: Linux/Mac/Windows/TypeDB Cloud/Google Cloud/AWS/Azure
18+
4. Driver version:
19+
5. Other details:
2220

2321
## Reproducible Steps
2422

25-
Steps to create the smallest reproducible scenario:
26-
1. { e.g. Run ... }
27-
2. { e.g. Load ... }
28-
3. { e.g. Query ... }
29-
4. { e.g. See error ... }
23+
1. Set up
24+
25+
26+
2. Execute
27+
28+
29+
3. Test/Query
3030

31-
## Expected Output
3231

33-
{ Please describe what you expected to happen. }
32+
4. Unexpected result
33+
34+
35+
36+
## Expected result
3437

35-
## Actual Output
3638

37-
{ Please describe what actually happened. }
38-
3939
## Additional information
4040

41-
{ Any additional information, including logs or screenshots if you have any. }
41+
Relevant logs from TypeDB or Driver:
42+
Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,17 @@
11
---
22
name: Feature Request
33
about: Request a feature here, or visit forum.typedb.com for ideas and questions
4-
title: ''
54
labels: feature
6-
assignees: ''
7-
85
---
96

10-
Please replace every line in curly brackets { like this } with appropriate answers, and remove this line.
11-
127
## Problem to Solve
138

14-
{ Please describe the problem you would like to solve. }
159

1610
## Current Workaround
1711

18-
{ Please describe how you currently solve or work around this problem, given TypeDB's limitation. }
1912

2013
## Proposed Solution
2114

22-
{ Please describe the solution you would like TypeDB to provide, to solve the problem above. }
2315

2416
## Additional Information
2517

26-
{ Any additional information, including logs or screenshots if you have any. }

.github/ISSUE_TEMPLATE/REFACTOR.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,8 @@ about: Propose an architecture refactor here
44
labels: refactor
55
---
66

7-
Please replace every line in curly brackets { like this } with appropriate answers, and remove this line.
8-
97
## Problem to Solve
108

11-
{ Please describe the problem with the current architecture that you would like to solve. }
129

1310
## Proposed Solution
1411

15-
{ Please describe how you would like to change the architecture, to solve the problem above. }

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
1-
**For the title of this PR:** please follow the grammatical rules of a usual publication title, without capitalisation (except for the first letter). Thus, the title should NOT CONTAIN CODE: no dots, no parentheses, no backticks, no brackets, etc. It needs to be distinctive (not detailed) and succinct (not lengthy). Details of this PR will go in the description. **For the description of this PR:** please replace every line in curly brackets ( { like this } ) with an appropriate description following the guidance. Finally, **please remove this paragraph**.
1+
## Release notes: usage and product changes
22

3-
## What is the goal of this PR?
43

5-
{ In the form of a paragraph (only use bullet points if strictly necessary), please describe the goal of this PR, why they are valuable to achieve, and reference the related GitHub issues. This section will be automatically compiled into the release notes, so please:
6-
- describe the impact of the change in this PR to the _user_ of this repository (e.g. end user, contributor, developer).
7-
- describe the new product behaviour in _present tense_, and the old behaviour and how it's been changed in _past tense_.
8-
- Use the _Royal We_: _"We"_ made changes, not _"I"_ made changes. }
9-
10-
## What are the changes implemented in this PR?
11-
12-
{ Please explain what you implemented, why your changes are the best way to achieve the goal(s) above. Please describe every method, class and package, by explaining:
13-
- its responsibility,
14-
- how it's expected to behave, and
15-
- how it relates to the adjacent methods/classes/packages it interacts with.
16-
17-
This would allow the reviewer to understand your intentions in the code much better. If you're adding new classes, make sure these explanations are also included in the class header comments. Last but not least, please reference the GitHub issues to be automatically closed, such like 'closes #number'. }
4+
## Implementation

0 commit comments

Comments
 (0)