Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jofairden authored Jul 15, 2020
1 parent ab2edf0 commit 3bf06b7
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Maintainers, please do not edit this file without notifying the entire team. Thank you. -->

# Contribution guidelines
Before you create a pull request, please review the following guidelines for your contribution. Thank you in advance
Before you create a pull request, please review the following guidelines for your contribution. Thank you in advance.

## Your files use tab indendation (keep tabs) of size 4
In our project, we use tab indentation with a size of 4. Please have your settings abide this rule.
Expand Down Expand Up @@ -49,10 +49,16 @@ This will create new patches containing your changes in the patches/ folder

![Example patcher](https://i.imgur.com/Ltol24M.png "Example Patcher")

**You can still commit other files if needed for example if you updated translations or sprites, but in general you should only commit patches.**

## You inspect your diffs (patches)
Before you propose your contribution, inspect your patches. Please make sure that file formatting didn't mess up (this can happen with certain plugins and addons!)

![Diff example](https://i.imgur.com/jwu2GOG.png "Diff example")

**Make sure your patch is as small as possible, so try to introduce as little changes as possible.** Sometimes this may require some additional thoughts about changes you make, and you may prefer a different approach to ensure a small patch difference.

For formatting it can help if your formatting tool supports our .editorconfig file. Ensure you have the same indentation levels, braces on the same line etc.

## Helpful tips for contributions
Because tModLoader is a big project, we want to make sure contributions don't introduce unnecessary code or code that is fundamentally flawed by design. But please don't be discouraged! If you are unsure about your contribution, still feel free to propose it and in your proposal ask us for feedback. If you do, please add "WIP:" in the title of your proposal. It is also helpful if you are specific about what you want feedback on. We will always try to provide you feedback in a passive and helpful manner.

0 comments on commit 3bf06b7

Please sign in to comment.