Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 2.27 KB
Raw

Contribution Guidelines

Welcome, and thank you for contributing to LootGoblin! Here's how you do it:

Step #1 - What do I add?

If you don't know what to add, it's recommended to play around and find things you want to improve by experimenting. Still clueless? Pick an issue from the issue tracker.

Step #2 - Forking and Cloning

To fork this repository, click on the fork button on the top right of your screen, and fork the repository.

Now that you have your own copy, make a new branch with a descriptive name (no, new-feature is not a descriptive name) and clone the repository to your local environment.

Step #3 - Write the Code

Just - do it. There's not much to detail here. Regarding code styling, stick to the official guidelines supplied by the Kotlin team. (Note: every function, property and class must have KDocs attached)

Step #4 - Make a Pull Request

Once you're done coding your new feature/bugfix, come back to your fork, and make a new Pull Request from your branch to the main branch.

Before creating your PR, make sure to:

  • Request a review from @TheOnlyTails.
  • Add a relevant label.
  • If your PR is supposed to close an issue, add "Closes #" ( e.g. "Closes #3" for issue number 3) at the end of your PR message.

Now that you've created your PR, the reviewers will discuss the changes with you, and automated checks will run on your code. IMPORTANT: Make sure to enable auto-squash and merge . Once it's enabled, your PR will be automatically merged once all checks pass and reviewers approve.

Step #5 - Celebrate

Hurray! You've made your first contribution to LootGoblin! 🎉