Skip to content

Commit d26f092

Browse files
unknwonunknwon
authored
github: refurbish issue forms and pull request templates (#312)
1 parent c71eccd commit d26f092

10 files changed

+202
-45
lines changed

‎.editorconfig

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true

‎.github/ISSUE_TEMPLATE/bug_report.md

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

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Bug report
2+
description: File a bug report to help us improve
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
10+
- Before you file an issue read the [Contributing guide](https://github.com/go-ini/ini/blob/main/.github/contributing.md).
11+
- Check to make sure someone hasn't already opened a similar [issue](https://github.com/go-ini/ini/issues).
12+
- type: input
13+
attributes:
14+
label: Version
15+
description: Please specify the exact Go module version you're reporting for.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Describe the bug
21+
description: A clear and concise description of what the bug is.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: To reproduce
27+
description: A code snippet to reproduce the problem described above.
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Expected behavior
33+
description: A clear and concise description of what you expected to happen.
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: Additional context
39+
description: |
40+
Links? References? Suggestions? Anything that will give us more context about the issue you are encountering!
41+
42+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
43+
validations:
44+
required: false
45+
- type: checkboxes
46+
attributes:
47+
label: Code of Conduct
48+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://go.dev/conduct)
49+
options:
50+
- label: I agree to follow this project's Code of Conduct
51+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Improve documentation
2+
description: Suggest an idea or a patch for documentation
3+
labels: ["documentation"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this form!
9+
10+
- Before you file an issue read the [Contributing guide](https://github.com/go-ini/ini/blob/main/.github/contributing.md).
11+
- Check to make sure someone hasn't already opened a similar [issue](https://github.com/go-ini/ini/issues).
12+
- type: textarea
13+
attributes:
14+
label: What needs to be improved? Please describe
15+
description: A clear and concise description of what is wrong or missing.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Why do you think it is important?
21+
description: A clear and concise explanation of the rationale.
22+
validations:
23+
required: true
24+
- type: checkboxes
25+
attributes:
26+
label: Code of Conduct
27+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://go.dev/conduct)
28+
options:
29+
- label: I agree to follow this project's Code of Conduct
30+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md

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

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: ["feature"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this form!
9+
10+
- Before you file an issue read the [Contributing guide](https://github.com/go-ini/ini/blob/main/.github/contributing.md).
11+
- Check to make sure someone hasn't already opened a similar [issue](https://github.com/go-ini/ini/issues).
12+
- type: textarea
13+
attributes:
14+
label: Describe the feature
15+
description: A clear and concise description of what the problem is, e.g. I'm always frustrated when [...]
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Describe the solution you'd like
21+
description: A clear and concise description of what you want to happen.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Describe alternatives you've considered
27+
description: A clear and concise description of any alternative solutions or features you've considered.
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Additional context
33+
description: |
34+
Links? References? Suggestions? Anything that will give us more context about the feature you are requesting!
35+
36+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
37+
validations:
38+
required: false
39+
- type: checkboxes
40+
attributes:
41+
label: Code of Conduct
42+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://go.dev/conduct)
43+
options:
44+
- label: I agree to follow this project's Code of Conduct
45+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1-
### What problem should be fixed?
1+
### Describe the pull request
22

3-
### Have you added test cases to catch the problem?
3+
A clear and concise description of what the pull request is about, i.e. what problem should be fixed?
4+
5+
Link to the issue: <!-- paste the issue link here, or put "n/a" if not applicable -->
6+
7+
### Checklist
8+
9+
- [ ] I agree to follow the [Code of Conduct](https://go.dev/conduct) by submitting this pull request.
10+
- [ ] I have read and acknowledge the [Contributing guide](https://github.com/go-ini/ini/blob/main/.github/contributing.md).
11+
- [ ] I have added test cases to cover the new code.

‎.github/contributing.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Welcome to go-ini contributing guide
2+
3+
Thank you for investing your time in contributing to our projects!
4+
5+
Read our [Code of Conduct](https://go.dev/conduct) to keep our community approachable and respectable.
6+
7+
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
8+
9+
Use the table of contents icon <img src="https://github.com/github/docs/raw/50561895328b8f369694973252127b7d93899d83/assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
10+
11+
## New contributor guide
12+
13+
To get an overview of the project, read the [README](/README.md). Here are some resources to help you get started with open source contributions:
14+
15+
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
16+
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
17+
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
18+
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
19+
20+
In addition to the general guides with open source contributions, you would also need to:
21+
22+
- Have basic knowledge about INI configuration format and programming in [Go](https://go.dev/).
23+
- Have a working local development setup with a reasonable good IDE or editor like [Visual Studio Code](https://code.visualstudio.com/docs/languages/go), [GoLand](https://www.jetbrains.com/go/) or [Vim](https://github.com/fatih/vim-go).
24+
25+
## Issues
26+
27+
### Create a new issue
28+
29+
- [Check to make sure](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments) someone hasn't already opened a similar [issue](https://github.com/go-ini/ini/issues).
30+
- If a similar issue doesn't exist, open a new issue using a relevant [issue form](https://github.com/go-ini/ini/issues/new/choose).
31+
32+
### Pick up an issue to solve
33+
34+
- Scan through our [existing issues](https://github.com/go-ini/ini/issues) to find one that interests you.
35+
- The [good first issue](https://github.com/go-ini/ini/labels/good%20first%20issue) is a good place to start exploring issues that are well-groomed for newcomers.
36+
- Do not hesitate to ask for more details or clarifying questions on the issue!
37+
- Communicate on the issue you are intended to pick up _before_ starting working on it.
38+
- Every issue that gets picked up will have an expected timeline for the implementation, the issue may be reassigned after the expected timeline. Please be responsible and proactive on the communication 🙇‍♂️
39+
40+
## Pull requests
41+
42+
When you're finished with the changes, create a pull request, or a series of pull requests if necessary.
43+
44+
Contributing to another codebase is not as simple as code changes, it is also about contributing influence to the design. Therefore, we kindly ask you that:
45+
46+
- Please acknowledge that no pull request is guaranteed to be merged.
47+
- Please always do a self-review before requesting reviews from others.
48+
- Please expect code review to be strict and may have multiple rounds.
49+
- Please make self-contained incremental changes, pull requests with huge diff may be rejected for review.
50+
- Please use English in code comments and docstring.
51+
- Please do not force push unless absolutely necessary. Force pushes make review much harder in multiple rounds, and we use [Squash and merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-pull-request-commits) so you don't need to worry about messy commits and just focus on the changes.
52+
53+
## Your PR is merged!
54+
55+
Congratulations 🎉🎉 Thanks again for taking the effort to have this journey with us 🌟

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ ini.sublime-workspace
44
testdata/conf_reflect.ini
55
.idea
66
/.vscode
7+
.DS_Store

0 commit comments

Comments
 (0)