equivalent-exchange-3/CONTRIBUTING.md

2.0 KiB

Contributing

First of all, thanks for contributing! 👍

Submitting a PR

So you found a 🐛 in the code? Think you can make it more efficient 💨? Want to help in general? Great!

  1. If you haven't already, create a Github account.
  2. Click the Fork icon located at the top-right of this page (below your username).
  3. Make the changes that you want to and commit them.
    • If you're making changes locally, you'll have to execute git commit -a and git push in your command line.
  4. Click Pull Request at the right-hand side of the gray bar directly below your fork's name.
  5. Click Click to create a pull request for this comparison, enter your PR's title, and create a detailed description telling pahimar what you changed.
  6. Click Send pull request, and wait for feedback! 💥

Creating an Issue

EE3 crashes every time 💣? Have a suggestion? Found a 🐛? Create an issue now!

  1. Make sure your issue hasn't already been answered or fixed by searching for it. Also think about whether your issue is a valid one before submitting it.
  2. Go to the issues page.
  3. Click New Issue right below Star and Fork.
  4. Enter your Issue's title (something that summarizes your issue), and then create a detailed description ("Hey pahimar, could you add/change xxx?" or "Hey, found an exploit: stuff").
    • If you are reporting a bug report from an unofficial version, make sure you include the following:
      • Commit SHA (usually located in a changelog or the jar name itself)
      • ForgeModLoader log
      • Server log if applicable
      • Detailed description of the bug and pictures if applicable
  5. Click Submit new issue, and wait for feedback! 💥