This repository has been archived by the owner on May 13, 2023. It is now read-only.
forked from WayofTime/BloodMagic
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add template for issues and contributing page
Removed Issue reporting and contributing sections from README
- Loading branch information
Showing
3 changed files
with
61 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Contributing to BloodMagic | ||
|
||
First off, thank you for taking the time to contribute! | ||
|
||
## Issues | ||
|
||
First, make sure the issue has not been already reported. | ||
|
||
If it has not been reported, follow the provided issue template (created when you click "New Issue"). | ||
|
||
If it has been reported, provide any additional information you can to the current active issue. | ||
|
||
## Pull Requests | ||
|
||
With the 1.8 rewrite comes a need to keep the code *clean*. Pull Requests will be looked over a bit stricter from now on. | ||
|
||
When you wish to contribute, please keep these points in mind: | ||
|
||
###Do: | ||
* Only make 1 commit for each major change. | ||
* This helps avoid "polluting" the Git history. | ||
* Squash extra commits. | ||
* See above. | ||
* Describe each and every change you make in your Pull Request. | ||
* This lets everybody know exactly what is going on for easy discussion. | ||
* Make short yet descriptive commit titles. | ||
* Feel free to give a very basic overview of the commit in the message, then use the description to go into detail. | ||
* Keep your formatting the same as the project. | ||
* This will be expanded upon at a later date. | ||
|
||
###Do not: | ||
* Make unnecessary changes to files. | ||
* If you don't need to touch it, don't touch it. | ||
* This includes: *renaming args*, *renaming files*, *editing formatting*, etc. | ||
* Use obfuscated names for parameters. | ||
* This makes the code look messier and less "professional". |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
#### Issue Description: | ||
Note: If this bug occurs in a modpack, please report this to the modpack author. Otherwise, delete this line and add your description here. If this is a feature request, this template does not apply to you. Just delete everything. | ||
|
||
|
||
#### What happens: | ||
|
||
|
||
|
||
#### What you expected to happen: | ||
|
||
|
||
|
||
#### Steps to reproduce: | ||
|
||
1. | ||
2. | ||
3. | ||
... | ||
|
||
____ | ||
#### Affected Versions (Do *not* use "latest"): | ||
|
||
- BloodMagic: | ||
- Minecraft: | ||
- Forge: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters