feat(docs): various improvements to docs, bots and templates (#2170)

This commit is contained in:
Daniel Gibbs 2019-02-02 15:22:53 +00:00 committed by GitHub
parent 837ca7d873
commit ccd026caff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 70 additions and 38 deletions

View File

@ -17,13 +17,13 @@ Issues here are **NOT** for:
* Dedicated server issues (e.g Ubuntu, CentOS)
* Anything not directly related to LinuxGSM development
Any general support issues on GitHub will be closed.
Any general support issues on GitHub will be migrated to [LinuxGSM-Support](https://github.com/GameServerManagers/LinuxGSM-Support).
*Please use the template below*
## User Story
As a \[user description], I want \[desired action] so that \[desired outcome]
As a \[user description], I want \[desired action] so that \[desired outcome].
## Basic info
@ -44,5 +44,3 @@ Steps to reproduce the behaviour:
4. See error
## Expected behaviour
A what you expected to happen.

View File

@ -12,21 +12,22 @@ Issues here are **ONLY** for:
* code contributions
Issues here are **NOT** for:
* General support
* Specific game server issues (e.g CS:GO, TF2)
* Dedicated server issues (e.g Ubuntu, CentOS)
* Anything not directly related to LinuxGSM development
Any general support issues on GitHub will be closed.
Any general support issues on GitHub will be migrated to [LinuxGSM-Support](https://github.com/GameServerManagers/LinuxGSM-Support).
*Please use the template below*
## User Story
As a \[user description], I want \[desired action] so that \[desired outcome]
As a \[user description], I want \[desired action] so that \[desired outcome].
## Basic info
## Basic info
As a \[user description], I want \[desired action] so that \[desired outcome]
* Distro \[Ubuntu 18.04]
* Game \[Garry's Mod]

View File

@ -4,7 +4,9 @@ about: Suggest a new game server to be added
---
## Which game server would you like adding?
## What game server would you like adding?
\[game server]
## Can you link to any tutorials or guides?
@ -12,8 +14,16 @@ Provide any useful documentation or resources that might help.
## Is the server on Steam?
If yes Use SteamDB to get the appid. (https://steamdb.info)
* [ ] Yes
* [ ] No
If yes Use SteamDB to get the appid. (https://steamdb.info).
\[appid]
## Is the server supported on Linux?
We only support Linux servers and do not support Wine.
* [ ] Yes
* [ ] No

View File

@ -1,9 +1,9 @@
# Configuration for probot-no-response - https://github.com/probot/no-response
# Number of days of inactivity before an Issue is closed for lack of response
daysUntilClose: 30
daysUntilClose: 60
# Label requiring a response
responseRequiredLabel: "Status: waiting response"
responseRequiredLabel: "needs more info"
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
closeComment: >
This issue has been automatically closed because there has been no response

View File

@ -1,6 +1,6 @@
# Label name and color to set, when potential duplicates are detected
issueLabel: "Type: potential duplicate"
labelColor: D2DAE1
issueLabel: "duplicate"
labelColor: 579e01
# If similarity is higher than this threshold, issue will be marked as duplicate
threshold: 0.60

View File

@ -2,7 +2,9 @@
# *Required* Comment to reply with
requestInfoReplyComment: >
We require more information for this issue.
![More Data required](https://i.imgur.com/yS9cecv.png)
More data is required to assist with this issue
or issue template was not used correctly.
https://linuxgsm.com/support/#guide
# *OPTIONAL* default titles to check against for lack of descriptiveness
@ -12,4 +14,4 @@ requestInfoReplyComment: >
# - updates
# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
requestInfoLabelToAdd: "Status: needs more info"
requestInfoLabelToAdd: "needs more info"

6
.github/welcome.yml vendored
View File

@ -4,18 +4,18 @@
# Comment to be posted to on first time issues
newIssueWelcomeComment: >
Thanks for opening your first issue. Be sure to follow the issue template! and guide for posting. https://linuxgsm.com/support/#guide
Thank you for opening your first issue. Be sure to follow the issue template! and guide for posting. https://linuxgsm.com/support/#guide
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
Thanks for opening this pull request! Please check out our contributing guidelines.
Thank you for opening this pull request! Please check out our contributing guidelines.
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
Congrats on merging your first pull request! Thank you for supporting LinuxGSM!
Congratulations on merging your first pull request! Thank you for supporting LinuxGSM!
# It is recommend to include as many gifs and emojis as possible

View File

@ -9,15 +9,13 @@ Before working on a project we recommend that you create a issue in regards to t
Here are some important resources:
* [Issues Page](https://github.com/GameServerManagers/LinuxGSM/issues) provides a list of areas that could use some work,
* [Developing LinuxGSM](https://docs.linuxgsm.com/developers) gives a detailed guide on developing LGSM,
* [LinuxGSM Exit Codes](https://docs.linuxgsm.com/developers/linuxgsm-exit-codes) describes and gives an explanation for exit codes,
* [Branching](https://docs.linuxgsm.com/developers/branching) is our final guide to submitting changes.
* [Developer Wiki](https://github.com/GameServerManagers/LinuxGSM/wiki) gives a detailed guide on developing LGSM,
## Testing
Please make sure all the code you write is working properly **before** you create a pull request. Information on debugging can be found in the following document:
[Developer Commands](https://docs.linuxgsm.com/developers/developer-commands)
[Debugging your code](https://docs.linuxgsm.com/developers/developing-lgsm#testing-and-debugging-your-code)
[Developer Commands](https://github.com/GameServerManagers/LinuxGSM/wiki/Developer-Commands)
## Submitting changes
@ -35,4 +33,4 @@ This will help us in understanding your code and determining where problems may
Start reading our code and you'll get the hang of it. Explore how functions are organized and you'll see how we strive for readable code.
Please give the following document a read and adjust your code according to its specifications.
[Syntax & Coding Conventions](https://docs.linuxgsm.com/developers/syntax-and-conventions)
[Syntax & Coding Conventions](https://github.com/GameServerManagers/LinuxGSM/wiki/Syntax-and-Conventions)

20
PULL_REQUEST_TEMPLATE.md Normal file
View File

@ -0,0 +1,20 @@
# Description
Please include a summary of the change and which issue is fixed.
Fixes #\[issue]
## Type of change
* [ ] Bug fix (non breaking change which fixes an issue)
* [ ] New feature (non breaking change which adds functionality)
* [ ] Refactor (non breaking change restructures existing code)
* [ ] This change requires a documentation update
## Checklist
* [ ] My code follows the style guidelines of this project
* [ ] This pull request links to an issue
* [ ] I have performed a self review of my own code
* [ ] I have commented my code, particularly in hard to understand areas
* [ ] I have made corresponding changes to the documentation

File diff suppressed because one or more lines are too long