Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (55 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

75 lines (55 loc) · 2.54 KB

Introduction

First off, thank you for considering contributing to this project. It's people like you that make the Minecraft community so great.

Following these guidelines helps to communicate that you respect the time of the people managing and developing this project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your contributions.

This project is open source and we love receiving contributions from the community - you! There are many ways to contribute, from adding your own assets, or fixing or improving existing assets, to submitting request for support for mods or reporting when things don't quite work right.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Contributor Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to contact@scottkillen.com.

Contributing

Reporting Problems

When reporting problems, please include:

  • The Minecraft version
  • Any involved mods
  • A description of how to reproduce the problem
  • A screenshot of the issue. (This is optional, but it will go along way to the speedy resolution of the problem.)

Nominating Mods

When nominating a mod to be textured, please include:

  • The name of the mod
  • A link to the mod
  • A short description of why this mod should be prioritized. (This is optional, but it will help us determine how to schedule this mod's inclusion.)

Contributing Textures

Important: Any textures you use must be your own or available under licensing compatible with this project's license.

Submitting changes

We recommend the following workflow:

  1. Fork the project.
  2. Check out the development branch.
  3. Create a new branch for your changes.
  4. Complete your work.
  5. Review your changes and test in-game.
  6. Check in your changes.
  7. Submit a pull request against the development branch in this project, using the branch you created in #3 above.
  8. Return to #2 and repeat, creating a different branch for a new group of changes.