mirror of
https://github.com/celisej567/BCWSsrc.git
synced 2026-09-15 20:12:39 +03:00
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
This commit is contained in:
43
.github/CONTRIBUTING.md
vendored
Normal file
43
.github/CONTRIBUTING.md
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
This file details how to contribute to the Mapbase project on GitHub:
|
||||
https://github.com/mapbase-source/source-sdk-2013
|
||||
|
||||
For the original Source SDK 2013 contribution guidelines, click here:
|
||||
https://github.com/ValveSoftware/source-sdk-2013/blob/master/CONTRIBUTING
|
||||
|
||||
---
|
||||
|
||||
Mapbase is a project which many Source modders draw from, so it has its own unique standards
|
||||
for contributions which differ from other projects, but it is still an open-source repository
|
||||
that is always open to contributions.
|
||||
|
||||
Whenever you contribute to the Mapbase repository, you must keep in mind that any contributions
|
||||
made could be deployed to all mods utilizing Mapbase, which can include everything from high-profile
|
||||
Steam mods to amateur HL2 maps. Many contributions can also end up being available in both SP and MP
|
||||
if the contributions are not obviously exclusive to one of the two.
|
||||
|
||||
All contributions must follow the following rules:
|
||||
|
||||
* A contribution must be aligned with Mapbase's goals and priorities and should not be "subjective"
|
||||
or related to a specific mod or type of mod. For example, fixing an existing issue or adding a
|
||||
new tool for mappers to use is usually fine, but adding a new custom weapon with its own assets
|
||||
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 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 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.
|
||||
You are encouraged to append an "Author(s)" part to that header in your file in order to clarify who wrote it.
|
||||
|
||||
If your contribution is accepted, you may be listed in Mapbase's credits and the README's external content list:
|
||||
https://github.com/mapbase-source/source-sdk-2013/wiki/Mapbase-Credits#Contributors
|
||||
https://github.com/mapbase-source/source-sdk-2013/blob/master/README
|
||||
|
||||
You may also receive the "Contributor" or "Major Contributor" role on Mapbase's Discord server if you are
|
||||
a member of it.
|
||||
|
||||
25
.github/ISSUE_TEMPLATE/bug-report---code.md
vendored
Normal file
25
.github/ISSUE_TEMPLATE/bug-report---code.md
vendored
Normal file
@@ -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.
|
||||
@@ -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
|
||||
@@ -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.
|
||||
@@ -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: ''
|
||||
@@ -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
.github/ISSUE_TEMPLATE/bug-report---npc.md
vendored
Normal file
25
.github/ISSUE_TEMPLATE/bug-report---npc.md
vendored
Normal file
@@ -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
.github/ISSUE_TEMPLATE/bug-report---tools.md
vendored
Normal file
25
.github/ISSUE_TEMPLATE/bug-report---tools.md
vendored
Normal file
@@ -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.
|
||||
@@ -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] "
|
||||
@@ -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.
|
||||
@@ -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
|
||||
@@ -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
.github/ISSUE_TEMPLATE/feature-request---code.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/feature-request---code.md
vendored
Normal file
@@ -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.
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
name: Game - Feature request
|
||||
name: Feature request - Game
|
||||
about: Suggest an idea related to game behavior.
|
||||
title: "[GAME] "
|
||||
labels: Enhancement
|
||||
@@ -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.
|
||||
@@ -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: ''
|
||||
@@ -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
.github/ISSUE_TEMPLATE/feature-request---npc.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/feature-request---npc.md
vendored
Normal file
@@ -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
.github/ISSUE_TEMPLATE/feature-request---tools.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/feature-request---tools.md
vendored
Normal file
@@ -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.
|
||||
@@ -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] "
|
||||
@@ -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.
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
name: VScript - Feature request
|
||||
name: Feature request - VScript
|
||||
about: Suggest an idea related to VScript.
|
||||
title: "[VSCRIPT] "
|
||||
labels: Enhancement, VScript
|
||||
@@ -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
.github/pull-request-template.md
vendored
Normal file
11
.github/pull-request-template.md
vendored
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user