Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 4.25 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 4.25 KB
Raw

Contributing to Protect Your Moa

Getting started for programmers

  1. Install the latest 64-bit version of OpenJDK 17. Check out Adoptium for the relevant JDK build for your OS.

  2. Install the latest 64-bit version of Git, which can be found on the Git website.

  3. Fork Protect Your Moa repository with the fork button in the top right of GitHub.

  4. We recommend to use IntelliJ IDEA Community Edition for contributions. Other IDEs may work but any issues or roadblocks will not receive support.

  5. We recommend a Git client if you are new to contributing, however if you know how to use Git you can also use the command line. Some client options are:

    1. IntelliJ IDEA itself (Tutorial)
    2. GitHub Desktop (Tutorial)
    3. GitKraken (Tutorial)
    4. SourceTree (Tutorial)

  6. Clone your fork of the repository with Git (note: if using IntelliJ IDEA for Git, this will automatically open the project as well).

  7. Open the locally cloned repository with IntelliJ IDEA and set up the project workspace.

    If you're not familiar with setting up IntelliJ IDEA for use with ForgeGradle projects, cpw has created a setup video on a few of the basics of ForgeGradle here.

  8. Create a branch for your changes named feat/<username>/<title>. Read up on your relevant Git tutorial if you are unsure how to do this.

  9. Run git config core.hooksPath .githooks in your Git client's terminal to configure git hooks for the workspace.

  10. Start developing!

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

Writing commits

If you are looking to commit to your fork and don't know how, make sure to read up on your relevant Git tutorial.

Once you're ready to commit, there are some things to know about our commit styling. Protect Your Moa makes uses of conventional commits. To understand this, we recommend you read up on Semantic Versioning first, and then our Conventional Commit standards.

It is important to use conventional commits because Protect Your Moa's workflow depends on them for code review and changelogs. Not using it makes management of contributions more difficult.

It is also important to understand semantic versioning as we recommend avoiding breaking changes, and also avoiding anything that could lead to future breaking changes being made.

Creating pull requests

To open a pull request, go to the pull requests page, and an indicator should show up on the page to create a PR from a recent commit to a fork.

When creating a PR:

  • Make sure your code conforms to the project's documentation and code styling.
  • Mark it as a draft if the changes are WIP.
  • Follow the template and example given when creating the PR.
  • Follow the instructions of anything written in [].
  • Make sure the description section meets Conventional Commit standards, as we put the information into the merge commit, just keep in mind the header becomes the title of the PR.

Code review

After your PR has been opened, we will make sure to label it with the relevant status, feat, and type labels and assign it to a developer for review. We will then review your code and test if it builds through CircleCI, as well as test the contents to verify they do as described.

If we request any changes, you will have to make them for your PR to be accepted.