Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing file #1631

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Contributing file #1631

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f8dc86
Prototype of Contributing file
LAGIdiot May 29, 2021
906d35a
Add additional tags
LAGIdiot Jun 5, 2021
db47645
Update CONTRIBUTING.md
LAGIdiot Jun 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved

### 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.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved

### 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.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
* Nothing similar? Then [open a new issue](https://github.com/GregTechCE/GregTech/issues/new/choose) using **Feature request** template.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved

### Have question regarding project?
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
* We have Discord (link above), feel free to hang out and ask your questions. There are always some community members which may provide answers.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
* 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?
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
* 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.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved

### Don't know how to code?
We will stay take your help.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
* 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.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
* 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)
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved

### 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.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
#### 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.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
#### 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.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
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.
LAGIdiot marked this conversation as resolved.
Show resolved Hide resolved
#### status: wip
This issue is getting prepared. For PRs there is draft function.


10 changes: 0 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.