From bd1dabc19403908a18594a0a1e3a19839bca84e6 Mon Sep 17 00:00:00 2001 From: Chaos <ChaosMTA@users.noreply.github.com> Date: Mon, 23 Jan 2017 14:49:08 -0600 Subject: [PATCH 1/4] Add a contributing guide This file will give new pull requests a warning to adhere to the projects guidelines and is a good reminder of our standards. https://help.github.com/articles/setting-guidelines-for-repository-contributors/ This is related to issue #1624 Feel free to suggest edits. --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..28d8d3dac --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# How to contribute + +I'm really glad you're reading this, because if you are then you have shown an interest in helping make LinuxGSM great. + +If you haven't already, come find us on [Discord](https://gameservermanagers.com/discord). From there you will have contact with other contributers of the project. We want you working on things you're excited about. + +Here are some important resources: + + * [Issues Page](https://github.com/GameServerManagers/LinuxGSM/issues) provides a list of areas that could use some work, + * [Developing LGSM](https://github.com/GameServerManagers/LinuxGSM/wiki/Developing-LGSM) gives a detailed guide on developing LGSM, + * [LGSM Exit Codes](https://github.com/GameServerManagers/LinuxGSM/wiki/LGSM-Exit-Codes) describes and gives an explanation for exit codes, + * [gsquery](https://github.com/GameServerManagers/LinuxGSM/wiki/gsquery.py) describes the uses of the gsquery.py file, and + * [Branching](https://github.com/GameServerManagers/LinuxGSM/wiki/Branching) is our final guide to submitting changes. + +## 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: +[Debug Command](https://github.com/GameServerManagers/LinuxGSM/wiki/debug) +[Debugging your code](https://github.com/GameServerManagers/LinuxGSM/wiki/Developing-LGSM#testing-and-debugging-your-code) + +## Submitting changes + +Please send a [GitHub Pull Request to LinuxGSM](https://github.com/GameServerManagers/LinuxGSM/pull/new/develop) with a clear list of what you've done (read more about [pull requests](https://help.github.com/articles/about-pull-requests/)). Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit). + +Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this: + + $ git commit -m "A brief summary of the commit + > + > A paragraph describing what changed and its impact." +This will help us in understanding your code and determining where problems may arise. + +## Coding conventions + +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://github.com/GameServerManagers/LinuxGSM/wiki/Syntax-&-Conventions) + + + From bf1dc5b71d2068575cbca01c25812023a64c0e5e Mon Sep 17 00:00:00 2001 From: Chaos <ChaosMTA@users.noreply.github.com> Date: Mon, 23 Jan 2017 15:43:11 -0600 Subject: [PATCH 2/4] Update based on code review --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28d8d3dac..6fe85bae6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# How to contribute +# How to contribute to LinuxGSM -I'm really glad you're reading this, because if you are then you have shown an interest in helping make LinuxGSM great. +We are really glad you're reading this, because if you are then you have shown an interest in helping make LinuxGSM great. If you haven't already, come find us on [Discord](https://gameservermanagers.com/discord). From there you will have contact with other contributers of the project. We want you working on things you're excited about. From 1272cb42c60f4788345d84e667efdcbbbb121eaa Mon Sep 17 00:00:00 2001 From: Chaos <ChaosMTA@users.noreply.github.com> Date: Mon, 23 Jan 2017 15:57:06 -0600 Subject: [PATCH 3/4] Updated to add developer commands --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6fe85bae6..edb8ebf50 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ Here are some important resources: ## 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: -[Debug Command](https://github.com/GameServerManagers/LinuxGSM/wiki/debug) +[Developer Commands](https://github.com/GameServerManagers/LinuxGSM/wiki/Developer-Commands) [Debugging your code](https://github.com/GameServerManagers/LinuxGSM/wiki/Developing-LGSM#testing-and-debugging-your-code) ## Submitting changes From 3e17bc1daa6098022ccc41e5dbac732fcb41fb9f Mon Sep 17 00:00:00 2001 From: Chaos <ChaosMTA@users.noreply.github.com> Date: Wed, 25 Jan 2017 08:41:59 -0600 Subject: [PATCH 4/4] Added a note about making an issue for features you work on --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index edb8ebf50..a90acec99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,8 @@ We are really glad you're reading this, because if you are then you have shown a If you haven't already, come find us on [Discord](https://gameservermanagers.com/discord). From there you will have contact with other contributers of the project. We want you working on things you're excited about. +Before working on a project we recommend that you create a issue in regards to the issue/feature. This will prevent duplicates while you work on the feature. If an issue already exists, make note that you are working on it so nobody else wastes their time working on the same project at the same time! + Here are some important resources: * [Issues Page](https://github.com/GameServerManagers/LinuxGSM/issues) provides a list of areas that could use some work,