Skip to content

Commit c06d421

Browse files
authored
chore: New github templates (#108)
Signed-off-by: Joel Hanson <joelhanson025@gmail.com>
1 parent 0ef5745 commit c06d421

File tree

5 files changed

+226
-49
lines changed

5 files changed

+226
-49
lines changed

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: "🐛 Bug Report"
2+
description: File a bug report
3+
title: "🐛 [BUG] - <title>"
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: What happened?
14+
description: Also tell us, what did you expect to happen?
15+
placeholder: Tell us what you see!
16+
value: "A bug happened!"
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Steps To Reproduce
22+
description: Steps to reproduce the behavior.
23+
placeholder: |
24+
1. In this environment...
25+
2. With this config...
26+
3. Run '...'
27+
4. See error...
28+
validations:
29+
required: false
30+
- type: textarea
31+
attributes:
32+
label: Environment
33+
description: |
34+
examples:
35+
- **OS**: Ubuntu 20.04
36+
- **Openshift**: 4.8.2
37+
- **Kubernetes**: v1.23.12+8a6bfe4
38+
value: |
39+
- OS:
40+
- Openshift:
41+
- Kubernetes:
42+
render: markdown
43+
validations:
44+
required: false
45+
- type: textarea
46+
attributes:
47+
label: Anything else?
48+
description: |
49+
Links? References? Anything that will give us more context about the issue you are encountering!
50+
51+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
52+
validations:
53+
required: false
54+
- type: dropdown
55+
id: version
56+
attributes:
57+
label: Version
58+
description: What version of our software are you running?
59+
options:
60+
- 1.3.2 (Default)
61+
- older (<1.3.2)
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: logs
66+
attributes:
67+
label: Relevant log output
68+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
69+
render: shell
70+
- type: checkboxes
71+
id: terms
72+
attributes:
73+
label: Code of Conduct
74+
description: By submitting this issue, you agree to follow our [Code of Conduct](../CODE_OF_CONDUCT.md)
75+
options:
76+
- label: I agree to follow this project's Code of Conduct
77+
required: true
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: "💡 Feature Request"
2+
description: Create a new ticket for a new feature request
3+
title: "💡 [Feature] - <title>"
4+
labels:
5+
- "feature_request"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
**Thanks :heart: for taking the time to fill out this feature request report!**
11+
We kindly ask that you search to see if an issue [already exists](https://github.com/ibm-messaging/kafka-connect-mq-source/issues?q=is%3Aissue+sort%3Acreated-desc+) for your feature.
12+
We are also happy to accept contributions from our users. For more details see [here](https://github.com/ibm-messaging/kafka-connect-mq-source/blob/master/CONTRIBUTING.md).
13+
- type: textarea
14+
attributes:
15+
label: Description
16+
description: |
17+
A clear and concise description of the feature you're interested in.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Suggested Solution
23+
description: |
24+
Describe the solution you'd like. A clear and concise description of what you want to happen.
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: Alternatives
30+
description: |
31+
Describe alternatives you've considered.
32+
A clear and concise description of any alternative solutions or features you've considered.
33+
validations:
34+
required: false
35+
- type: textarea
36+
attributes:
37+
label: Additional Context
38+
description: |
39+
Add any other context about the problem here.
40+
validations:
41+
required: false

.github/PULL_REQUEST_TEMPLATE

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Description
2+
3+
<!-- Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
## How Has This Been Tested?
17+
18+
<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
19+
20+
- [ ] Test A
21+
- [ ] Test B -->
22+
23+
## Checklist
24+
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes
32+
- [ ] Any dependent changes have been merged and published in downstream modules

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,16 @@ To contribute code or documentation, please submit a [pull request](https://gith
1111
A good way to familiarize yourself with the codebase and contribution process is
1212
to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/ibm-messaging/kafka-connect-mq-source/issues).
1313

14-
## Create issues...
14+
## Create issues
15+
1516
If you would like to implement a new feature, please [raise an issue](https://github.com/ibm-messaging/kafka-connect-mq-source/issues)
1617
before sending a pull request so the feature can be discussed before you start working on it.
1718

1819
> Note: We appreciate your effort, and want to avoid a situation where a contribution
1920
requires extensive rework (by you or by us), sits in backlog for a long time, or
2021
cannot be accepted at all!
2122

22-
### ...but check for existing issues first!
23+
### ...but check for existing issues first
2324

2425
Please take a moment to check that an issue doesn't already exist documenting your bug report or improvement proposal. If it does, it never hurts to add a quick "+1" or "I have this problem too". This will help prioritize the most common problems and requests.
2526

@@ -36,7 +37,7 @@ Each source file must include a license header for the Apache
3637
Software License 2.0.
3738
e.g.
3839

39-
```
40+
```txt
4041
/**
4142
* Copyright <date>-<date> <holder>
4243
*
@@ -61,7 +62,8 @@ uses to manage code contributions.
6162

6263
The rules are pretty simple: if you
6364
can certify the below (from [developercertificate.org](http://developercertificate.org/)):
64-
```
65+
66+
```txt
6567
Developer Certificate of Origin
6668
Version 1.1
6769
@@ -102,11 +104,11 @@ By making a contribution to this project, I certify that:
102104

103105
then you just add a line to end of the git commit message:
104106

105-
```
107+
```txt
106108
Signed-off-by: John Doe <john.doe@example.com>
107109
```
108110

109111
using your real name. Sorry, no pseudonyms or anonymous contributions.
110112

111113
Many Git UI tools have support for adding the `Signed-off-by` line to the end of your commit
112-
message. This line can be automatically added by the `git commit` command by using the `-s` option.
114+
message. This line can be automatically added by the `git commit` command by using the `-s` option.

0 commit comments

Comments
 (0)