Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (37 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 3.13 KB

Contributing to Piko

Thank you for considering contributing to this event library! Your contributions will help to make it even better.

How to Contribute

There are many ways to contribute to this project, from writing tutorials and implement new features, to fixing bugs and improving the code.

GitHub Issues

GitHub Issues

Reporting Bugs

If you find a bug, please report it by creating a new issue on the project's issue tracker. Be sure to include a clear and concise description of the issue, as well as steps to reproduce it.

Suggesting Features

If you have a great idea for a new feature, please let us know by creating a new issue on the project's issue tracker. Be sure to include a clear and concise description of the feature, and explain why you think it would be valuable to the project.

Writing Code

If you are interested in contributing code to the project, here are a few things to keep in mind:

  • The code should be well-documented and easy to understand.
  • All code should be written in Kotlin
  • Before submitting a pull request, make sure that your code has been tested thoroughly and does not cause any issues with the existing code.

Pull Requests

License and Copyright

By contributing to this project, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This ensures that the project remains free and open-source, and that any derivative works are also shared under the same license. Additionally, you confirm that the code you commit is your own work or you have the right to submit it.

For more details, please refer to the AGPL-3.0 license.

Style Guide

When contributing code, please follow the project's coding style and conventions. This includes:

  • JetBrains' coding conventions for Kotlin.
  • IntelliJ IDEA's default code style for Java.
  • Oracles's naming conventions for Java.

Code of Conduct

By participating in this project, you agree to follow the project's code of conduct. This includes treating all contributors with respect and refraining from any form of harassment or discrimination.

Get in Touch

If you have any questions or need help getting started, please feel free to reach out by creating an issue on the project's GitHub repository. We would be happy to help!

Discord Server