Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.31 KB

Contributing to CommandHunt

First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to CommandHunt, which is hosted in the CommandHunt Repository on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Development Process

GitHub is used to track issues and feature requests, as well as accept pull requests.

Pull Requests

Feel free to submit pull requests.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

Issues

GitHub Issues is used to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Coding Style

  • The backend module follows Google Java Style. Use google-java-format plugin.
  • The frontend module follows the default formatting of Visual Studio Code editor.

License

By contributing to CommandHunt, you agree that your contributions will be licensed under its MIT License.