Skip to content

Commit 3bc3b61

Browse files
jsonzillajsonzilla
authored
Update issue templates (#23)
* Update issue and contributing templates
1 parent d58a4a4 commit 3bc3b61

File tree

5 files changed

+247
-0
lines changed

5 files changed

+247
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: jsonzilla
7+
8+
---
9+
10+
**Note: for support questions, please use stackoverflow**.
11+
This repository's issues are reserved for feature requests and bug reports.
12+
Your issue may already be reported! Please search on the [issue tab](../) before creating one.
13+
14+
<!--- Provide a general summary of the issue in the Title above -->
15+
16+
## Expected Behavior
17+
<!--- Tell us what should happen -->
18+
19+
## Current Behavior
20+
<!--- Tell us what happens instead of the expected behavior -->
21+
22+
## Possible Solution
23+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
24+
25+
## Steps to Reproduce
26+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
27+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
28+
1.
29+
2.
30+
3.
31+
4.
32+
33+
## Context (Environment)
34+
<!--- How has this issue affected you? What are you trying to accomplish? -->
35+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
36+
37+
<!--- Provide a general summary of the issue in the Title above -->
38+
* **Version**: <!-- compulsory. you must provide your version -->
39+
* **Platform**: <!-- either `uname -a` output, or if Windows, version and 32-bit or 64-bit -->
40+
* **Subsystem**: <!-- optional. if known - please specify affected core module name -->
41+
* **Files**: <!-- optional. if known - please specify affected files -->
42+
43+
## Detailed Description
44+
<!--- Provide a detailed description of the change or addition you are proposing -->
45+
46+
## Possible Implementation
47+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[REQUEST]"
5+
labels: enhancement
6+
assignees: jsonzilla
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Note: for support questions, please use stackoverflow**.
14+
This repository's issues are reserved for feature requests and bug reports.
15+
Your issue may already be reported! Please search on the [issue tab](../) before creating one.
16+
17+
**Describe the solution you'd like**
18+
A clear and concise description of what you want to happen.
19+
20+
**Describe alternatives you've considered**
21+
A clear and concise description of any alternative solutions or features you've considered.
22+
23+
**Additional context**
24+
Add any other context or screenshots about the feature request here.

‎CONTRIBUTING.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributing
2+
3+
## Request for changes/ Pull Requests
4+
You first need to create a fork of the repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
5+
6+
Then add your fork as a local project:
7+
8+
```sh
9+
# Using HTTPS
10+
git clone https://github.com/jsonzilla/REPOSITORY.git
11+
12+
# Using SSH
13+
git clone git@github.com:jsonzilla/REPOSITORY.git
14+
```
15+
16+
> [Which remote URL should be used ?](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories)
17+
18+
Then, go to your local folder
19+
20+
```sh
21+
cd github-issue-template
22+
```
23+
24+
Add git remote controls :
25+
26+
```sh
27+
# Using HTTPS
28+
git remote add fork https://github.com/YOUR-USERNAME/REPOSITORY.git
29+
git remote add upstream https://github.com/jsonzilla/REPOSITORY.git
30+
31+
32+
# Using SSH
33+
git remote add fork git@github.com:YOUR-USERNAME/REPOSITORY.git
34+
git remote add upstream git@github.com/jsonzilla/REPOSITORY.git
35+
```
36+
37+
You can now verify that you have your two git remotes:
38+
39+
```sh
40+
git remote -v
41+
```
42+
43+
## Receive remote updates
44+
In view of staying up to date with the central repository :
45+
46+
```sh
47+
git pull upstream master
48+
```
49+
50+
## Choose a base branch
51+
Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use master.
52+
53+
| Type of change | | Branches |
54+
| :------------------ |:---------:| ---------------------:|
55+
| Documentation | | `master` or `main` |
56+
| Bug fixes | | `master` or `main` |
57+
| New features | | `master` or `main` |
58+
| New issues models | | `YOUR-USERNAME:patch` |
59+
60+
```sh
61+
# Switch to the desired branch
62+
git switch master
63+
# or
64+
git switch main
65+
66+
# Pull down any upstream changes
67+
git pull
68+
69+
# Create a new branch to work on
70+
git switch --create patch/1234-name-issue
71+
```
72+
73+
Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the REPOSITORY repository](https://github.com/jsonzilla/REPOSITORY/) following the template provided.

‎ISSUE_TEMPLATE.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
**Note: for support questions, please use stackoverflow**.
2+
This repository's issues are reserved for feature requests and bug reports.
3+
Your issue may already be reported! Please search on the [issue tab](../) before creating one.
4+
5+
<!--- Provide a general summary of the issue in the Title above -->
6+
7+
## I'm submitting a ...
8+
- [ ] bug report
9+
- [ ] feature request
10+
- [ ] support request => Please do not submit support request here, see note at the top of this template.
11+
12+
## Do you want to request a *feature* or report a *bug*?
13+
14+
## Expected Behavior
15+
<!--- Tell us what should happen -->
16+
17+
## Current Behavior
18+
<!--- Tell us what happens instead of the expected behavior -->
19+
20+
## Possible Solution
21+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
22+
23+
## Steps to Reproduce
24+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
25+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
26+
1.
27+
2.
28+
3.
29+
4.
30+
31+
## Context (Environment)
32+
<!--- How has this issue affected you? What are you trying to accomplish? -->
33+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
34+
35+
<!--- Provide a general summary of the issue in the Title above -->
36+
* **Version**: <!-- compulsory. you must provide your version -->
37+
* **Platform**: <!-- either `uname -a` output, or if Windows, version and 32-bit or 64-bit -->
38+
* **Subsystem**: <!-- optional. if known - please specify affected core module name -->
39+
* **Files**: <!-- optional. if known - please specify affected files -->
40+
41+
## Detailed Description
42+
<!--- Provide a detailed description of the change or addition you are proposing -->
43+
44+
## Possible Implementation
45+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->

‎PULL_REQUEST_TEMPLATE.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
A similar PR may already be submitted! Please search among the [Pull request](../) before creating one.
2+
3+
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:
4+
5+
For more information, see the `CONTRIBUTING` guide.
6+
7+
8+
## Summary
9+
10+
<!-- Summary of the PR -->
11+
12+
This PR fixes/implements the following **bugs/features**
13+
14+
* [ ] Bug 1
15+
* [ ] Bug 2
16+
* [ ] Feature 1
17+
* [ ] Feature 2
18+
* [ ] Breaking changes
19+
20+
<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
21+
22+
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
23+
24+
<!-- Bug fix, feature, docs update, ... -->
25+
26+
* **What is the current behavior?** (You can also link to an open issue here)
27+
28+
<!-- You can also link to an open issue here -->
29+
30+
* **What is the new behavior (if this is a feature change)?**
31+
32+
<!-- If this is a feature change -->
33+
34+
* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
35+
36+
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
37+
38+
## Checklist
39+
40+
* **Please check if the PR fulfills these requirements**
41+
- [ ] The commit message follows our guidelines
42+
- [ ] Tests for the changes have been added (for bug fixes / features)
43+
- [ ] Docs have been added / updated (for bug fixes / features)
44+
45+
## Test plan (required)
46+
47+
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
48+
49+
<!-- Make sure tests pass -->
50+
51+
## Closing issues
52+
53+
<!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
54+
Fixes #
55+
56+
## Other information:
57+
58+
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->

0 commit comments

Comments
 (0)