Skip to content

Commit 6ba3cd4

Browse files
BlixibonBlixibon
authored
GitHub community issue/contribution changes (#75)
Overhauled Mapbase's GitHub-specific files to be more effective and project-agnostic * Moved CONTRIBUTING to .github so it can be recognized as contribution guidelines * Added more issue templates and made them more project-agnostic for forks * Renamed issue templates so "Bug report", "Feature request", etc. come first when looking for the right template * Added pull request template
1 parent 54cca19 commit 6ba3cd4

17 files changed

Lines changed: 173 additions & 21 deletions

‎.gitattributes‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ vpc_osx binary
3636
*.inl text
3737
*.asm text
3838

39+
.github/CONTRIBUTING.md text
3940
.gitignore text
4041
sourcesdk_def.mak text
4142
smdlexp.mak text
4243
README text
43-
CONTRIBUTING text
4444
LICENSE text
4545

4646
*.exe binary

CONTRIBUTING renamed to .github/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ All contributions must follow the following rules:
2323
is usually not fit for Mapbase.
2424

2525
* All content in a contribution must be either already legally open-source or done with the
26-
full permission of the contribution's original creator(s).
26+
full permission of the content's original creator(s).
2727

2828
* Contributions must not break existing maps/content or interfere with them in a negative or non-objective way.
2929

3030
* Code contributions are not obliged to follow Mapbase's preprocessor conventions (e.g. #ifdef MAPBASE),
31-
although following them is acceptable.
31+
although following them is usually acceptable.
3232

3333
* If you are contributing a file you created yourself specifically for Mapbase, you are required to
3434
use the custom "Mapbase - Source 2013" header used in other Mapbase files as of Mapbase v5.0.

‎.github/ISSUE_TEMPLATE/bug-report---code.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Bug report - Code
3+
about: Create a bug report related to the source code itself. (e.g. a compile error)
4+
title: "[CODE] "
5+
labels: Bug
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the bug
11+
A clear and concise description of what the bug is.
12+
13+
### Steps to reproduce
14+
Steps to reproduce the behavior:
15+
1. Have '...' set to something
16+
2. ???
17+
3. See error
18+
19+
### Expected behavior
20+
A clear and concise description of what you expected to happen.
21+
22+
---
23+
24+
### Additional context
25+
(Optional) Add any other context about the problem here.

.github/ISSUE_TEMPLATE/game---bug-report.md renamed to .github/ISSUE_TEMPLATE/bug-report---game.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Game - Bug report
2+
name: Bug report - Game
33
about: Create a bug report related to game behavior.
44
title: "[GAME] "
55
labels: Bug
@@ -22,4 +22,4 @@ A clear and concise description of what you expected to happen.
2222
---
2323

2424
### Additional context
25-
Add any other context about the problem here.
25+
(Optional) Add any other context about the problem here.

.github/ISSUE_TEMPLATE/miscellaneous---bug-report.md renamed to .github/ISSUE_TEMPLATE/bug-report---misc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
name: Miscellaneous - Bug report
3-
about: Create a bug report not related to any of the subjects mentioned above.
2+
name: Bug report - Miscellaneous
3+
about: Create a bug report not related to any of the other subjects.
44
title: "[MISC] "
55
labels: Bug
66
assignees: ''
@@ -22,4 +22,4 @@ A clear and concise description of what you expected to happen.
2222
---
2323

2424
### Additional context
25-
Add any other context about the problem here.
25+
(Optional) Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/bug-report---npc.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Bug report - NPCs
3+
about: Create a bug report related to NPCs.
4+
title: "[NPCs] "
5+
labels: Bug
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the bug
11+
A clear and concise description of what the bug is.
12+
13+
### Steps to reproduce
14+
Steps to reproduce the behavior:
15+
1. Have '...' do something
16+
2. ???
17+
3. See error
18+
19+
### Expected behavior
20+
A clear and concise description of what you expected to happen.
21+
22+
---
23+
24+
### Additional context
25+
(Optional) Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/bug-report---tools.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Bug report - Tools
3+
about: Create a bug report related to compile tools, editor stuff, etc.
4+
title: "[TOOLS] "
5+
labels: Bug, Tools
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the bug
11+
A clear and concise description of what the bug is.
12+
13+
### Steps to reproduce
14+
Steps to reproduce the behavior:
15+
1. Have '...' in the map
16+
2. ???
17+
3. See error
18+
19+
### Expected behavior
20+
A clear and concise description of what you expected to happen.
21+
22+
---
23+
24+
### Additional context
25+
(Optional) Add any other context about the problem here.

.github/ISSUE_TEMPLATE/visuals-graphics---bug-report.md renamed to .github/ISSUE_TEMPLATE/bug-report---visuals-graphics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Visuals/Graphics - Bug report
2+
name: Bug report - Visuals/Graphics
33
about: Create a bug report related to visual issues. (e.g. shaders, projected textures,
44
etc.)
55
title: "[VISUAL] "
@@ -26,4 +26,4 @@ Any related screenshots, videos, etc. which show the bug.
2626
---
2727

2828
### Additional context
29-
Add any other context about the problem here.
29+
(Optional) Add any other context about the problem here.

.github/ISSUE_TEMPLATE/vscript---bug-report.md renamed to .github/ISSUE_TEMPLATE/bug-report---vscript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: VScript - Bug report
2+
name: Bug report - VScript
33
about: Create a bug report related to VScript.
44
title: "[VSCRIPT] "
55
labels: Bug, VScript
@@ -22,4 +22,4 @@ A clear and concise description of what you expected to happen.
2222
---
2323

2424
### Additional context
25-
Add any other context about the problem here.
25+
(Optional) Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature-request---code.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request - Code
3+
about: Suggest an idea related to the source code itself. (e.g. a new utility function)
4+
title: "[CODE] "
5+
labels: Enhancement
6+
assignees: ''
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+
### Describe the solution you'd like
14+
A clear and concise description of what you want to happen.
15+
16+
### Describe alternatives you've considered
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
---
20+
21+
### Additional context
22+
(Optional) Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)