Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (30 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 2.42 KB

Contributing Guidelines

Thank you for showing interest in contributing to our game and community. If you want an overview of this project, please refer to README.md.

Before contributing, please read our Code of Conduct along with this document.

If you don't have git set up on your machine, please follow this guide.

If you haven't developed using JavaFX and FXGL, please watch this video first.

Types of Contributions Accepted

We accept the following types of contributions:

Issues

If you've found a bug in the game itself or something else (e.g. documentation), you can open an issue to let the community know. You can also open an issue to let us know about a feature you want to see developed or address anything else related to the project.

If you see an issue you would like to develop a solution for, please comment on that issue and a community leader will assign it to you.

Please make sure to look at all other open issues here first to make sure that your issue hasn't already been brought up by someone else.

Pull requests

If you decide to develop a solution for an issue, you can submit these changes through a pull request.

Pull Request Title Format

PR titles must follow this format: type(scope): description (#issue).

  • type (required): One of feat, fix, refactor, docs, test, chore
  • scope (optional): Context in parentheses, e.g. (auth), (readme)
  • description (required): A clear description of the change
  • (#issue) (optional): The issue number in parentheses with a hash, e.g. (#335)

Examples:

  • feat(auth): add OAuth2 support (#42)
  • fix: handle null token
  • docs(readme): update setup instructions (#335)

If this is your first time contributing to open source, please refer to this guide on how to submit a pull request.

After submitting a pull request, a community leader will review it promptly and suggest changes if necessary. Your solution will then be merged into the main branch and the pull request will be closed.