From 3f8dc866d3e4f37716df5b51dde8c7ffe078021d Mon Sep 17 00:00:00 2001 From: LAGIdiot Date: Sat, 29 May 2021 12:46:57 +0200 Subject: [PATCH 1/3] Prototype of Contributing file --- CONTRIBUTING.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 10 ------- 2 files changed, 80 insertions(+), 10 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..58a26c8513 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,80 @@ +# Contributing to GregTech Community Edition +First off, thank you for your interest in contributing! Remember every contribution counts. +#### [![Discord](https://img.shields.io/discord/432092648724103190.svg?colorB=7289DA&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHYAAABWAgMAAABnZYq0AAAACVBMVEUAAB38%2FPz%2F%2F%2F%2Bm8P%2F9AAAAAXRSTlMAQObYZgAAAAFiS0dEAIgFHUgAAAAJcEhZcwAACxMAAAsTAQCanBgAAAAHdElNRQfhBxwQJhxy2iqrAAABoElEQVRIx7WWzdGEIAyGgcMeKMESrMJ6rILZCiiBg4eYKr%2Fd1ZAfgXFm98sJfAyGNwno3G9sLucgYGpQ4OGVRxQTREMDZjF7ILSWjoiHo1n%2BE03Aw8p7CNY5IhkYd%2F%2F6MtO3f8BNhR1QWnarCH4tr6myl0cWgUVNcfMcXACP1hKrGMt8wcAyxide7Ymcgqale7hN6846uJCkQxw6GG7h2MH4Czz3cLqD1zHu0VOXMfZjHLoYvsdd0Q7ZvsOkafJ1P4QXxrWFd14wMc60h8JKCbyQvImzlFjyGoZTKzohwWR2UzSONHhYXBQOaKKsySsahwGGDnb%2FiYPJw22sCqzirSULYy1qtHhXGbtgrM0oagBV4XiTJok3GoLoDNH8ooTmBm7ZMsbpFzi2bgPGoXWXME6XT%2BRJ4GLddxJ4PpQy7tmfoU2HPN6cKg%2BledKHBKlF8oNSt5w5g5o8eXhu1IOlpl5kGerDxIVT%2BztzKepulD8utXqpChamkzzuo7xYGk%2FkpSYuviLXun5bzdRf0Krejzqyz7Z3p0I1v2d6HmA07dofmS48njAiuMgAAAAASUVORK5CYII%3D)](https://discord.gg/Tp3yDnE) + +## Want to contribute as player? +We appreciate feedback from our players as it is you why we are doing all of this. Without you, we would not be where we are. + +### Found a bug? +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/GregTechCE/GregTech/issues). +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/GregTechCE/GregTech/issues/new/choose) using **Bug report** template. +Be sure to include a **title and clear description**, as much relevant information as possible, let the template be your guide. + +### Something is missing? Thought about a cool feature? +* Check if there is similar idea under [Issues](https://github.com/GregTechCE/GregTech/issues) and if so but something is missing then please collaborate on it. +* Nothing similar? Then [open a new issue](https://github.com/GregTechCE/GregTech/issues/new/choose) using **Feature request** template. + +### Have question regarding project? +* We have Discord (link above), feel free to hang out and ask your questions. There are always some community members which may provide answers. +* Discord not your thing? Okay, understandable, then please [open a new issue](https://github.com/GregTechCE/GregTech/issues/new/choose) using **Question** template. + +### Anything else? +* Discord is right place for it. + +## Want to contribute some more? +We are mostly organizing our self on Discord and it is preferred place to discuss issues or quickly exchange info. +GitHub is more of input, output and storage kind of place. +Of course if we made any decision regarding issues/PRs we will write it on GitHub, so it is available to anyone. + +### Know foreign language and want to contribute translation? +* If we already have language files for it feel free to review them and let us know any mistakes or improvements. +* We don't have then, and you feel brave enough to make them then please join us on Discord, so we can discuss it. + +### Don't know how to code? +We will stay take your help. +* You can look through open issues with [status: unverified](https://github.com/GregTechCE/GregTech/labels/status%3A%20unverified) and confirm they are present. +On simplest possible configuration and write down reproduction steps if they are missing. Or provide any other related information. +* Or you can let us know what you think on issues with tag [open for discussion](https://github.com/GregTechCE/GregTech/labels/open%20for%20discussion). +* Maybe your expertise may helps us on issues with [status: help needed](https://github.com/GregTechCE/GregTech/labels/status%3A%20help%20needed) + +### Know how to mod or at least code? + + +## Tag explanation +Tags are used across issues and PRs to quickly determine what given items is about. +### Shared +#### integration +There is some integration to either CT, JEI or TOP. +#### subsystem +Defines related areas for this record. For example issue reporting problems with cables should be marked with subsystem: cables. +#### type: duplicate +This item duplicates some other. +They should be linked, if there is some useful information it should be transferred adn this item should be closed. +#### status: accepted +For PR it means it will be included in next release of appropriate size. +For Issue it means it can be worked on. It is either small enough that requirements are known from description. +Or it has abstract defining acceptance criteria and implementation specification. + +### PR specific +#### release note needed +There is need for explanation of given feature/bug in release notes +#### rsr (Release size requirements) +Defines under which circumstances can be this included in release. +There are 4 sizes +* Revision (small addition or transparent change without big effect on existing games) +* Minor (nondestructive or destructive must have change to API, change to recipes or mechanics) +* Major (destructive change to API, save games compatibility problems, major mechanics rework) +* Undetermined (size of change is not known) +Currently, only first 2 mentioned are releasable. +#### status: release blocker +Next release can't get out without this PR. + +### Issue specific +#### question +This issue is question and should be close after answering it. +#### status: workaround exists +There is a known workaround for give issue. +#### status: wip +This issue is getting prepared. For PRs there is draft function. + + diff --git a/README.md b/README.md index 24bb5f1484..4d80f5e8e2 100644 --- a/README.md +++ b/README.md @@ -39,16 +39,6 @@ GTCE follows a two week release cycle (when possible). Changelogs are generated and beautified after merging PRs every other Monday. Changelog is then submitted as a Pull Request (PR). Releases are built and deployed on Tuesdays after merging the Changelog PR. -## Contribution ### Current state of project GTCE is under active development with regular updates. It is primarily maintained by a "GTCE Council" of contributors of various talent: developers, designers and modpack authors. This council is coordinated by @LAGIdiot. The GTCE community is very active and regularly contributes code, testing and ideas. We are always looking for contributors! - -### How to contribute -Remember: Every contribution counts. -Found a bug? Please let us know by creating an Issue with the bug template. -Something is missing? Thought about a cool feature idea? Of course there's a template for that. We'll have a look! -Know how to mod or at least code? Then don't hesitate and jump to Discord channel, contact the Maintainer to discuss possible contribution. -Anything else? Sure come to Discord. - - From 906d35a33b275669ad35c91074e4d539256b8f31 Mon Sep 17 00:00:00 2001 From: LAGIdiot Date: Sat, 5 Jun 2021 12:09:25 +0200 Subject: [PATCH 2/3] Add additional tags Update broken language --- CONTRIBUTING.md | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58a26c8513..69cc4c93f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,19 +3,19 @@ First off, thank you for your interest in contributing! Remember every contribut #### [![Discord](https://img.shields.io/discord/432092648724103190.svg?colorB=7289DA&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHYAAABWAgMAAABnZYq0AAAACVBMVEUAAB38%2FPz%2F%2F%2F%2Bm8P%2F9AAAAAXRSTlMAQObYZgAAAAFiS0dEAIgFHUgAAAAJcEhZcwAACxMAAAsTAQCanBgAAAAHdElNRQfhBxwQJhxy2iqrAAABoElEQVRIx7WWzdGEIAyGgcMeKMESrMJ6rILZCiiBg4eYKr%2Fd1ZAfgXFm98sJfAyGNwno3G9sLucgYGpQ4OGVRxQTREMDZjF7ILSWjoiHo1n%2BE03Aw8p7CNY5IhkYd%2F%2F6MtO3f8BNhR1QWnarCH4tr6myl0cWgUVNcfMcXACP1hKrGMt8wcAyxide7Ymcgqale7hN6846uJCkQxw6GG7h2MH4Czz3cLqD1zHu0VOXMfZjHLoYvsdd0Q7ZvsOkafJ1P4QXxrWFd14wMc60h8JKCbyQvImzlFjyGoZTKzohwWR2UzSONHhYXBQOaKKsySsahwGGDnb%2FiYPJw22sCqzirSULYy1qtHhXGbtgrM0oagBV4XiTJok3GoLoDNH8ooTmBm7ZMsbpFzi2bgPGoXWXME6XT%2BRJ4GLddxJ4PpQy7tmfoU2HPN6cKg%2BledKHBKlF8oNSt5w5g5o8eXhu1IOlpl5kGerDxIVT%2BztzKepulD8utXqpChamkzzuo7xYGk%2FkpSYuviLXun5bzdRf0Krejzqyz7Z3p0I1v2d6HmA07dofmS48njAiuMgAAAAASUVORK5CYII%3D)](https://discord.gg/Tp3yDnE) ## Want to contribute as player? -We appreciate feedback from our players as it is you why we are doing all of this. Without you, we would not be where we are. +We appreciate feedback from our players as you are the reason why we are doing all of this. Without you, we would not be where we are. ### Found a bug? * **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/GregTechCE/GregTech/issues). * If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/GregTechCE/GregTech/issues/new/choose) using **Bug report** template. -Be sure to include a **title and clear description**, as much relevant information as possible, let the template be your guide. +Be sure to include a **title and clear description**, with as much relevant information as possible, let the template be your guide. ### Something is missing? Thought about a cool feature? -* Check if there is similar idea under [Issues](https://github.com/GregTechCE/GregTech/issues) and if so but something is missing then please collaborate on it. -* Nothing similar? Then [open a new issue](https://github.com/GregTechCE/GregTech/issues/new/choose) using **Feature request** template. +* Check if there is similar idea under [Issues](https://github.com/GregTechCE/GregTech/issues) and if so, feel free to add more information and thoughts to the issue. +* Nothing similar? Then [open a new issue](https://github.com/GregTechCE/GregTech/issues/new/choose) using the **Feature request** template. -### Have question regarding project? -* We have Discord (link above), feel free to hang out and ask your questions. There are always some community members which may provide answers. +### Have a question regarding project? +* We have a Discord (link above), feel free to hang out and ask your questions. There are always some community members which may provide answers. * Discord not your thing? Okay, understandable, then please [open a new issue](https://github.com/GregTechCE/GregTech/issues/new/choose) using **Question** template. ### Anything else? @@ -26,16 +26,16 @@ We are mostly organizing our self on Discord and it is preferred place to discus GitHub is more of input, output and storage kind of place. Of course if we made any decision regarding issues/PRs we will write it on GitHub, so it is available to anyone. -### Know foreign language and want to contribute translation? +### Know a foreign language and want to contribute translation? * If we already have language files for it feel free to review them and let us know any mistakes or improvements. -* We don't have then, and you feel brave enough to make them then please join us on Discord, so we can discuss it. +* If we don't have the language files, and you feel brave enough to make them, then please reach out to us on Discord, so we can discuss it. ### Don't know how to code? -We will stay take your help. +We can still take your help. * You can look through open issues with [status: unverified](https://github.com/GregTechCE/GregTech/labels/status%3A%20unverified) and confirm they are present. On simplest possible configuration and write down reproduction steps if they are missing. Or provide any other related information. * Or you can let us know what you think on issues with tag [open for discussion](https://github.com/GregTechCE/GregTech/labels/open%20for%20discussion). -* Maybe your expertise may helps us on issues with [status: help needed](https://github.com/GregTechCE/GregTech/labels/status%3A%20help%20needed) +* Maybe your expertise could help us on issues with [status: help needed](https://github.com/GregTechCE/GregTech/labels/status%3A%20help%20needed) ### Know how to mod or at least code? @@ -46,14 +46,14 @@ Tags are used across issues and PRs to quickly determine what given items is abo #### integration There is some integration to either CT, JEI or TOP. #### subsystem -Defines related areas for this record. For example issue reporting problems with cables should be marked with subsystem: cables. +Defines related areas for this issue or PR. For example, an issue reporting problems with cables should be marked with subsystem: cables. #### type: duplicate This item duplicates some other. -They should be linked, if there is some useful information it should be transferred adn this item should be closed. +They should be linked, if there is some useful information it should be transferred and this item should be closed. #### status: accepted For PR it means it will be included in next release of appropriate size. -For Issue it means it can be worked on. It is either small enough that requirements are known from description. -Or it has abstract defining acceptance criteria and implementation specification. +For Issue it means it can be worked on. It is either small enough that requirements are known from the description, +or it has abstract defining acceptance criteria and implementation specification. ### PR specific #### release note needed @@ -68,12 +68,20 @@ There are 4 sizes Currently, only first 2 mentioned are releasable. #### status: release blocker Next release can't get out without this PR. +#### early merge adept +Is given to PRs with big impact (mostly performance, or addons) which required more testing time or addons need more time to adjust to it +#### impact +Given if changes are expected to have impact that may create need to be handled. +For example: API changes, recipe changes, JEI category changes, etc... +Defines who will be affected by this change, options: +* Addons +* Modpacks ### Issue specific #### question This issue is question and should be close after answering it. #### status: workaround exists -There is a known workaround for give issue. +There is a known workaround for the given issue. #### status: wip This issue is getting prepared. For PRs there is draft function. From db4764588e2f4b55208e944053fcb84d13b6be5f Mon Sep 17 00:00:00 2001 From: LAGIdiot Date: Sun, 6 Jun 2021 13:31:48 +0200 Subject: [PATCH 3/3] Update CONTRIBUTING.md Co-authored-by: ALongStringOfNumbers <31759736+ALongStringOfNumbers@users.noreply.github.com> --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69cc4c93f8..8034c3bbca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ Of course if we made any decision regarding issues/PRs we will write it on GitHu ### Don't know how to code? We can still take your help. * You can look through open issues with [status: unverified](https://github.com/GregTechCE/GregTech/labels/status%3A%20unverified) and confirm they are present. -On simplest possible configuration and write down reproduction steps if they are missing. Or provide any other related information. +Please attempt to confirm issues with the simplest possible configuration, and provide reproduction steps if they are missing from the original issue. You can also provide any other related information you have discovered, to attempt to clarify the issue. * Or you can let us know what you think on issues with tag [open for discussion](https://github.com/GregTechCE/GregTech/labels/open%20for%20discussion). * Maybe your expertise could help us on issues with [status: help needed](https://github.com/GregTechCE/GregTech/labels/status%3A%20help%20needed) @@ -85,4 +85,3 @@ There is a known workaround for the given issue. #### status: wip This issue is getting prepared. For PRs there is draft function. -