From 6ba3cd4c0324a90b83b4a7ba12705c0f5433b536 Mon Sep 17 00:00:00 2001 From: Blixibon Date: Tue, 22 Dec 2020 10:13:07 -0600 Subject: [PATCH] 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 --- .gitattributes | 2 +- CONTRIBUTING => .github/CONTRIBUTING.md | 4 +-- .github/ISSUE_TEMPLATE/bug-report---code.md | 25 +++++++++++++++++++ ...e---bug-report.md => bug-report---game.md} | 4 +-- ...s---bug-report.md => bug-report---misc.md} | 6 ++--- .github/ISSUE_TEMPLATE/bug-report---npc.md | 25 +++++++++++++++++++ .github/ISSUE_TEMPLATE/bug-report---tools.md | 25 +++++++++++++++++++ ...rt.md => bug-report---visuals-graphics.md} | 4 +-- ...-bug-report.md => bug-report---vscript.md} | 4 +-- .../ISSUE_TEMPLATE/feature-request---code.md | 22 ++++++++++++++++ ...e-request.md => feature-request---game.md} | 4 +-- ...e-request.md => feature-request---misc.md} | 6 ++--- .../ISSUE_TEMPLATE/feature-request---npc.md | 22 ++++++++++++++++ .../ISSUE_TEMPLATE/feature-request---tools.md | 22 ++++++++++++++++ ... => feature-request---visuals-graphics.md} | 4 +-- ...equest.md => feature-request---vscript.md} | 4 +-- .github/pull-request-template.md | 11 ++++++++ 17 files changed, 173 insertions(+), 21 deletions(-) rename CONTRIBUTING => .github/CONTRIBUTING.md (95%) create mode 100644 .github/ISSUE_TEMPLATE/bug-report---code.md rename .github/ISSUE_TEMPLATE/{game---bug-report.md => bug-report---game.md} (83%) rename .github/ISSUE_TEMPLATE/{miscellaneous---bug-report.md => bug-report---misc.md} (67%) create mode 100644 .github/ISSUE_TEMPLATE/bug-report---npc.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report---tools.md rename .github/ISSUE_TEMPLATE/{visuals-graphics---bug-report.md => bug-report---visuals-graphics.md} (84%) rename .github/ISSUE_TEMPLATE/{vscript---bug-report.md => bug-report---vscript.md} (82%) create mode 100644 .github/ISSUE_TEMPLATE/feature-request---code.md rename .github/ISSUE_TEMPLATE/{game---feature-request.md => feature-request---game.md} (83%) rename .github/ISSUE_TEMPLATE/{miscellaneous---feature-request.md => feature-request---misc.md} (72%) create mode 100644 .github/ISSUE_TEMPLATE/feature-request---npc.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request---tools.md rename .github/ISSUE_TEMPLATE/{visuals-graphics---feature-request.md => feature-request---visuals-graphics.md} (82%) rename .github/ISSUE_TEMPLATE/{vscript---feature-request.md => feature-request---vscript.md} (82%) create mode 100644 .github/pull-request-template.md diff --git a/.gitattributes b/.gitattributes index 8309c7d7..a438df12 100644 --- a/.gitattributes +++ b/.gitattributes @@ -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 diff --git a/CONTRIBUTING b/.github/CONTRIBUTING.md similarity index 95% rename from CONTRIBUTING rename to .github/CONTRIBUTING.md index 508dc5e2..48256d92 100644 --- a/CONTRIBUTING +++ b/.github/CONTRIBUTING.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/bug-report---code.md b/.github/ISSUE_TEMPLATE/bug-report---code.md new file mode 100644 index 00000000..49724747 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report---code.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/game---bug-report.md b/.github/ISSUE_TEMPLATE/bug-report---game.md similarity index 83% rename from .github/ISSUE_TEMPLATE/game---bug-report.md rename to .github/ISSUE_TEMPLATE/bug-report---game.md index 60cf7396..bdce4b18 100644 --- a/.github/ISSUE_TEMPLATE/game---bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report---game.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/miscellaneous---bug-report.md b/.github/ISSUE_TEMPLATE/bug-report---misc.md similarity index 67% rename from .github/ISSUE_TEMPLATE/miscellaneous---bug-report.md rename to .github/ISSUE_TEMPLATE/bug-report---misc.md index 8c9af282..ca74bb35 100644 --- a/.github/ISSUE_TEMPLATE/miscellaneous---bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report---misc.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/bug-report---npc.md b/.github/ISSUE_TEMPLATE/bug-report---npc.md new file mode 100644 index 00000000..a526c312 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report---npc.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/bug-report---tools.md b/.github/ISSUE_TEMPLATE/bug-report---tools.md new file mode 100644 index 00000000..cdbe3beb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report---tools.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/visuals-graphics---bug-report.md b/.github/ISSUE_TEMPLATE/bug-report---visuals-graphics.md similarity index 84% rename from .github/ISSUE_TEMPLATE/visuals-graphics---bug-report.md rename to .github/ISSUE_TEMPLATE/bug-report---visuals-graphics.md index 296fc564..8e4c66f8 100644 --- a/.github/ISSUE_TEMPLATE/visuals-graphics---bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report---visuals-graphics.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/vscript---bug-report.md b/.github/ISSUE_TEMPLATE/bug-report---vscript.md similarity index 82% rename from .github/ISSUE_TEMPLATE/vscript---bug-report.md rename to .github/ISSUE_TEMPLATE/bug-report---vscript.md index 1eaf17c5..244fbc21 100644 --- a/.github/ISSUE_TEMPLATE/vscript---bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report---vscript.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature-request---code.md b/.github/ISSUE_TEMPLATE/feature-request---code.md new file mode 100644 index 00000000..c1a7cc5e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request---code.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/game---feature-request.md b/.github/ISSUE_TEMPLATE/feature-request---game.md similarity index 83% rename from .github/ISSUE_TEMPLATE/game---feature-request.md rename to .github/ISSUE_TEMPLATE/feature-request---game.md index 4d2554f0..b943b87d 100644 --- a/.github/ISSUE_TEMPLATE/game---feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request---game.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/miscellaneous---feature-request.md b/.github/ISSUE_TEMPLATE/feature-request---misc.md similarity index 72% rename from .github/ISSUE_TEMPLATE/miscellaneous---feature-request.md rename to .github/ISSUE_TEMPLATE/feature-request---misc.md index 94c81d57..3f5ef86c 100644 --- a/.github/ISSUE_TEMPLATE/miscellaneous---feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request---misc.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature-request---npc.md b/.github/ISSUE_TEMPLATE/feature-request---npc.md new file mode 100644 index 00000000..a8ae910d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request---npc.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature-request---tools.md b/.github/ISSUE_TEMPLATE/feature-request---tools.md new file mode 100644 index 00000000..3043db79 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request---tools.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/visuals-graphics---feature-request.md b/.github/ISSUE_TEMPLATE/feature-request---visuals-graphics.md similarity index 82% rename from .github/ISSUE_TEMPLATE/visuals-graphics---feature-request.md rename to .github/ISSUE_TEMPLATE/feature-request---visuals-graphics.md index c76c9735..5067b45b 100644 --- a/.github/ISSUE_TEMPLATE/visuals-graphics---feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request---visuals-graphics.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/vscript---feature-request.md b/.github/ISSUE_TEMPLATE/feature-request---vscript.md similarity index 82% rename from .github/ISSUE_TEMPLATE/vscript---feature-request.md rename to .github/ISSUE_TEMPLATE/feature-request---vscript.md index b3db3207..dde39768 100644 --- a/.github/ISSUE_TEMPLATE/vscript---feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request---vscript.md @@ -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. diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md new file mode 100644 index 00000000..53db0cc8 --- /dev/null +++ b/.github/pull-request-template.md @@ -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 + + +#### 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