Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 2.76 KB
Raw

NotEssential Contributions Guidelines

Thank you for contributing to our website! It really helps in maintaining our website and keeping it up-to-date. We recommend joining our Discord server so you can interact with NotEssential maintainers and ask for help in the NE chats.

Easily solvable using issues

To request the inclusion of a mod, report a bug or request a change in documentation, please open an issue on the Issues tab, using the appropriate template.

Translate NotEssential

To help translate NotEssential, please visit our Crowdin page.

If your language is not listed, join our Discord server and request your language to be added in the #ne-general chat.

General guidelines for translations:

  • Unless they have an official name in your language, do NOT translate a mod's name into that language.
  • Similarly, do NOT translate 'Essential'(the mod), 'Spark Universe', 'Mojang', 'Microsoft' or any mod names if there isn't an official name in that language.
  • If there is an issue, please make a comment on the side panel and tick the Issues box. Then, select the related flag.
  • When an area is in ALL CAPS, also write in ALL CAPS if you can with your language.

If you have any more questions, please join our Discord and ask there.

Help code NotEssential

To assist in developing NotEssential, fork this repository and create a new branch to start off with. Then, checkout your branch locally and start coding.

General guidelines for developing:

  • Make sure you look at the Pull Requests page to see if your idea has already been listed. If there isn't one, we recommend opening pull requests to the head branch/repository (the head branch is the branch merging to the repository).
  • Make your commit names helpful so we can understand what you have changed.
  • Install Prettier. You can run pnpm add prettier or install Prettier as a VS Code extension (this should have been recommended to you automatically!). If you use the extension, ensure Format on Save is set in VS Code settings.
  • Make sure you use our pull request template when making a pull request.
  • ONLY TICK THE BOXES YOU NEED TO TICK, this will help us a lot.

If you need help or have identified an issue that you cannot solve by yourself, open an issue in the Issues tab and link to your pull request in there.

Adding a mod to the alternatives page

Similar to above, fork this repository and create a new branch based off main. Then, checkout your branch locally and start coding.

General guidelines when adding a mod are available in the pull request template provided. Please also follow the guidelines in Help code NotEssential when making your changes.

For more help, please join our Discord server.