Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 2.59 KB
Raw

Submitting translations

Localization of the Dawn Team mods is managed through the Crowdin project.

Submitting ideas

You can submit ideas for new features over on the issue tracker.

Getting started for code modification

We're excited to hear that you're interested in contributing to Promenade!

Before getting started, you'll need to install the latest 64-bit version of the OpenJDK 8 for your environment.

  • Windows users: We strongly recommend you use the Hotspot OpenJDK 8 builds provided by the AdoptOpenJDK project instead of the builds provided by Oracle.
  • macOS and Linux users: If you are already using a package manager, OpenJDK builds should be present in your software repositories. If not, we recommend using SDKMan to install the Hotspot OpenJDK 8 builds provided by the AdoptOpenJDK project.

We strongly recommend you use IntelliJ IDEA Community Edition when making code contributions. While other IDEs may work (in theory, anyway), you will often run into issues and other roadblocks. If you're not familiar with setting up IntelliJ IDEA for use with Fabric projects, the community of Fabric has created a wiki which runs over a lot of the basics of Fabric here.

If you have any questions or issues, or would just like to discuss Promenade development, feel free to join us on Discord.

Creating pull requests

Please make sure before opening a pull request that:

  • Your pull request has an overview of the changes it makes, along with a link to the open issue(s) it resolves, if applicable.
  • Your changes include appropriate documentation and conform to our style guidelines.
  • If your merge request contains multiple commits, that you squash them before submitting.
  • You state in the description of your merge request that you agree to the Contributor License Agreement (CLA) found below.

Contributor License Agreement

By submitting code, assets, or documentation to the repository you are hereby agreeing that:

  • You grant Hugman the right to use your contributions under the LGPL v3.0 license.
  • Your contributions are of your own work and are free of legal restrictions (such as patents or copyrights).

If you have any questions about these terms, please get in contact with us.
If you do not agree to these terms, please do not submit contributions to this repository.