Skip to content

Commit b9cc6d5

Browse files
committed
Improve GitHub issue and pull request templates
1 parent f83d00f commit b9cc6d5

File tree

3 files changed

+43
-44
lines changed

3 files changed

+43
-44
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,20 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
84
---
95

10-
**Checklist**
11-
12-
- [ ] I tried to reproduce the bug in my fork of the [Kotlin Libraries Playground](https://github.com/LouisCAD/kotlin-libraries-playground), or in one of the samples in this repository
13-
- [ ] I have run with `$ ./gradlew --scan refreshVersions` to [provide a Build Scan URL](https://dev.to/jmfayard/the-one-gradle-trick-that-supersedes-all-the-others-5bpg)
14-
15-
**Describe the bug**
16-
6+
- [ ] I have read the [guidelines for submitting issues](https://jmfayard.github.io/refreshVersions/contributing/submitting-issues/)
7+
## 🐛 Describe the bug
178
<!-- A clear and concise description of what the bug is. -->
189

19-
**To Reproduce**
20-
21-
Build scan URL: https://scans.gradle.com/s/xxxxxxxxxx
22-
23-
<!-- Steps to reproduce the behavior: -->
24-
<!-- 1. ... -->
25-
<!-- 2. ... -->
26-
<!-- 3. ... -->
27-
<!-- 4. See error -->
10+
## ⚠️ Current behavior
11+
<!-- A clear and concise description of what you expected to happen. -->
2812

29-
**Expected behavior**
13+
## Expected behavior
3014
<!-- A clear and concise description of what you expected to happen. -->
3115

32-
**Additional context**
33-
<!-- Add any other context about the problem here. -->
16+
## 💣 Steps to reproduce
17+
<!-- How we can reproduce the behavior: -->
18+
19+
## 📱 Tech info
20+
- [Build Scan URL](https://dev.to/jmfayard/the-one-gradle-trick-that-supersedes-all-the-others-5bpg): <!-- e.g. Nexus One -->
Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,17 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
84
---
95

6+
- [ ] I have read the [guidelines for submitting issues](https://jmfayard.github.io/refreshVersions/contributing/submitting-issues/)
107

11-
**Is your feature request related to a problem? Please describe.**
8+
## ⚠️ Is your feature request related to a problem? Please describe
129
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1310

14-
**Using the samples**
15-
16-
If possible, fork the project and submit a change in the samples that demo what your idea would do differently
17-
18-
- `$ git clone https://github.com/jmfayard/buildSrcVersions`
19-
- `$ cd sample-groovy` # or `sample-kotlin` or `sample-versionsOnlyMode`
20-
- change things and submit a pull-request
21-
22-
23-
**Describe the solution you'd like**
11+
## 💡 Describe the solution you'd like
2412
<!-- A clear and concise description of what you want to happen. -->
2513

26-
27-
**Describe alternatives you've considered**
28-
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
29-
30-
**Additional context**
31-
<!-- Add any other context or screenshots about the feature request here. -->
14+
## 🤚 Do you want to develop this feature yourself?
15+
<!-- Put an `x` symbol into braces of desired choice. -->
16+
- [ ] Yes
17+
- [ ] No

.github/PULL_REQUEST_TEMPLATE

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- Thanks for taking the time to write this Pull Request ❤️ -->
2+
3+
## 🚀 Description
4+
<!-- Describe your changes in detail -->
5+
6+
## 📄 Motivation and Context
7+
<!-- Why is this change required? What problem does it solve? -->
8+
<!-- If it fixes an open issue, please link to the issue here. -->
9+
10+
## 🧪 How Has This Been Tested?
11+
<!-- Please describe in detail how you tested your changes. -->
12+
<!-- Include details of your testing environment, tests ran to see how -->
13+
<!-- your change affects other areas of the code, etc. -->
14+
15+
## 📦 Types of changes
16+
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
17+
- [ ] Bug fix (non-breaking change which fixes an issue)
18+
- [ ] New feature (non-breaking change which adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
20+
21+
## ✅ Checklist
22+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
23+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
24+
- [ ] I have read the [guidelines for the development process](https://jmfayard.github.io/refreshVersions/contributing/submitting-prs/dev-process/)
25+
- [ ] My change requires a change to the documentation.
26+
- [ ] I have updated the documentation accordingly.

0 commit comments

Comments
 (0)