Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 2.18 KB

File metadata and controls

47 lines (36 loc) · 2.18 KB

Contributing to Create: Tramways

Thanks for considering contibuting to the Create: Tramways project. Any contributions, big or small, are very welcome. This guide will tell you how to contribute to this project specifically, this is not a comprehensive guide to use the git software, the Github platform, how to program in java, etc.

Guidance for bug reporters

  • Please report bugs using by creating a new issue
  • Please include details such as operating system, Minecraft version, Modloader, Modloader version, Create version, and Create: Tramways version.
  • Please include latest.log, debug.log, and/or a crash report with your issue. Please do not upload these to Github or paste them directly into the issue, instead upload them to a service such as mclo.gs and include the link it gives you.

Guidance for all contributors

  • Please try to use clear summaries as your commits. Please no keyboard abuse, joke commit messages may be permitted if they are clever and related to what you are commiting.
  • Please always target the default branch! At time of writing it is 1.20.1/dev, this might change in the future if/when 1.20.1 support is dropped and I might have forgotten to change this guide so please check. I will port your changes to other existing versions for you.

Guidance for programmers

  • Please take note of surrounding code, try to follow the same formatting conventions, naming conventions, etc.
  • Please do not use an automatic formatter to reformat the files you have worked on, this makes it difficult to see what you've actually changed.

Guidance for translators

  • You can find a complete and up to date English lang file here.
  • Please place your completed lang file in common/src/main/resources/assets/tramways/lang/, and not in the folder where you got the source English lang file from.

Questions

If you have extra questions that this guide does not answer, the preferred method of contact is on the Discord server.