Skip to content

Commit

Permalink
GitHub community issue/contribution changes (#75)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
Blixibon authored Dec 22, 2020
1 parent 54cca19 commit 6ba3cd4
Show file tree
Hide file tree
Showing 17 changed files with 173 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ vpc_osx binary
*.inl text
*.asm text

.github/CONTRIBUTING.md text
.gitignore text
sourcesdk_def.mak text
smdlexp.mak text
README text
CONTRIBUTING text
LICENSE text

*.exe binary
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ All contributions must follow the following rules:
is usually not fit for Mapbase.

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

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

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

* If you are contributing a file you created yourself specifically for Mapbase, you are required to
use the custom "Mapbase - Source 2013" header used in other Mapbase files as of Mapbase v5.0.
Expand Down
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report---code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug report - Code
about: Create a bug report related to the source code itself. (e.g. a compile error)
title: "[CODE] "
labels: Bug
assignees: ''

---

### Describe the bug
A clear and concise description of what the bug is.

### Steps to reproduce
Steps to reproduce the behavior:
1. Have '...' set to something
2. ???
3. See error

### Expected behavior
A clear and concise description of what you expected to happen.

---

### Additional context
(Optional) Add any other context about the problem here.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Game - Bug report
name: Bug report - Game
about: Create a bug report related to game behavior.
title: "[GAME] "
labels: Bug
Expand All @@ -22,4 +22,4 @@ A clear and concise description of what you expected to happen.
---

### Additional context
Add any other context about the problem here.
(Optional) Add any other context about the problem here.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Miscellaneous - Bug report
about: Create a bug report not related to any of the subjects mentioned above.
name: Bug report - Miscellaneous
about: Create a bug report not related to any of the other subjects.
title: "[MISC] "
labels: Bug
assignees: ''
Expand All @@ -22,4 +22,4 @@ A clear and concise description of what you expected to happen.
---

### Additional context
Add any other context about the problem here.
(Optional) Add any other context about the problem here.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report---npc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug report - NPCs
about: Create a bug report related to NPCs.
title: "[NPCs] "
labels: Bug
assignees: ''

---

### Describe the bug
A clear and concise description of what the bug is.

### Steps to reproduce
Steps to reproduce the behavior:
1. Have '...' do something
2. ???
3. See error

### Expected behavior
A clear and concise description of what you expected to happen.

---

### Additional context
(Optional) Add any other context about the problem here.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report---tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug report - Tools
about: Create a bug report related to compile tools, editor stuff, etc.
title: "[TOOLS] "
labels: Bug, Tools
assignees: ''

---

### Describe the bug
A clear and concise description of what the bug is.

### Steps to reproduce
Steps to reproduce the behavior:
1. Have '...' in the map
2. ???
3. See error

### Expected behavior
A clear and concise description of what you expected to happen.

---

### Additional context
(Optional) Add any other context about the problem here.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Visuals/Graphics - Bug report
name: Bug report - Visuals/Graphics
about: Create a bug report related to visual issues. (e.g. shaders, projected textures,
etc.)
title: "[VISUAL] "
Expand All @@ -26,4 +26,4 @@ Any related screenshots, videos, etc. which show the bug.
---

### Additional context
Add any other context about the problem here.
(Optional) Add any other context about the problem here.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: VScript - Bug report
name: Bug report - VScript
about: Create a bug report related to VScript.
title: "[VSCRIPT] "
labels: Bug, VScript
Expand All @@ -22,4 +22,4 @@ A clear and concise description of what you expected to happen.
---

### Additional context
Add any other context about the problem here.
(Optional) Add any other context about the problem here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request---code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request - Code
about: Suggest an idea related to the source code itself. (e.g. a new utility function)
title: "[CODE] "
labels: Enhancement
assignees: ''

---

### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

### Describe the solution you'd like
A clear and concise description of what you want to happen.

### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

---

### Additional context
(Optional) Add any other context or screenshots about the feature request here.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Game - Feature request
name: Feature request - Game
about: Suggest an idea related to game behavior.
title: "[GAME] "
labels: Enhancement
Expand All @@ -19,4 +19,4 @@ A clear and concise description of any alternative solutions or features you've
---

### Additional context
Add any other context or screenshots about the feature request here.
(Optional) Add any other context or screenshots about the feature request here.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Miscellaneous - Feature request
about: Suggest an idea not related to any of the subjects mentioned above.
name: Feature request - Miscellaneous
about: Suggest an idea not related to any of the other subjects.
title: "[MISC] "
labels: Enhancement
assignees: ''
Expand All @@ -19,4 +19,4 @@ A clear and concise description of any alternative solutions or features you've
---

### Additional context
Add any other context or screenshots about the feature request here.
(Optional) Add any other context or screenshots about the feature request here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request---npc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request - NPCs
about: Suggest an idea related to NPCs.
title: "[NPCs] "
labels: Enhancement
assignees: ''

---

### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

### Describe the solution you'd like
A clear and concise description of what you want to happen.

### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

---

### Additional context
(Optional) Add any other context or screenshots about the feature request here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request---tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request - Tools
about: Suggest an idea related to compile tools, editor stuff, etc.
title: "[TOOLS] "
labels: Enhancement, Tools
assignees: ''

---

### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

### Describe the solution you'd like
A clear and concise description of what you want to happen.

### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

---

### Additional context
(Optional) Add any other context or screenshots about the feature request here.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Visuals/Graphics - Feature request
name: Feature request - Visuals/Graphics
about: Suggest an idea related to visuals or graphics. (e.g. shaders, projected textures,
etc.)
title: "[VISUAL] "
Expand All @@ -20,4 +20,4 @@ A clear and concise description of any alternative solutions or features you've
---

### Additional context
Add any other context or screenshots about the feature request here.
(Optional) Add any other context or screenshots about the feature request here.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: VScript - Feature request
name: Feature request - VScript
about: Suggest an idea related to VScript.
title: "[VSCRIPT] "
labels: Enhancement, VScript
Expand All @@ -19,4 +19,4 @@ A clear and concise description of any alternative solutions or features you've
---

### Additional context
Add any other context or screenshots about the feature request here.
(Optional) Add any other context or screenshots about the feature request here.
11 changes: 11 additions & 0 deletions .github/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
(Describe your PR here and then fill out the checklist at the bottom)

---

#### Does this PR close any issues?
* (Optional) Insert issue number(s) and any related info here

<!-- Replace [ ] with [x] for each item your PR satisfies -->
#### PR Checklist
- [ ] **My PR follows all guidelines in the CONTRIBUTING.md file**
- [ ] My PR targets a `develop` branch OR targets another branch with a specific goal in mind

0 comments on commit 6ba3cd4

Please sign in to comment.