Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 2.66 KB

Contribute to PistonChat

Contributions can fix behavior, improve documentation, or add focused tests.

Before you start

Read the support guide for questions and issue routing. Search existing issues and pull requests. Discuss larger API, architecture, or dependency changes before implementation.

Work from main and target that branch in your pull request. Keep each change focused. Avoid unrelated formatting and dependency updates.

Prepare a checkout

Use JDK 25 for the Gradle daemon. The Java modules select their own Java 21 toolchain. Use the checked-in wrapper.

Run the commands below from the repository root unless a command names another directory. On Windows, use gradlew.bat in place of ./gradlew for Gradle commands.

Repository layout

  • PistonChat/: chat behavior and commands.
  • PistonFilter/: chat filters.
  • PistonMute/: mute behavior.
  • buildSrc/: shared build and formatting conventions.

Verify your change

./gradlew test spotlessCheck
./gradlew build

Keep chat, filter, and mute behavior in the matching module. Preserve permissions and configuration compatibility. Add focused tests for message filters and state changes. For a runtime change, verify chat and commands on a disposable server.

Run the relevant checks before review. State the command and result in the pull request. If a check cannot run, explain the missing dependency or service. Do not claim it passed. Keep generated artifacts consistent with their source and review their diff.

Style and documentation

Follow the existing code conventions and repository formatter. Keep commit hooks enabled. Add focused tests for changed logic when practical. Avoid tests that only assert source strings. Update documentation when commands, APIs, configuration, or expected behavior change. Keep examples small and reproducible. Preserve exact identifiers, commands, and error messages.

Open a pull request

Explain the problem and resulting behavior. Link related issues without a placeholder issue number. Name the affected plugin modules. Describe any changed permission, command, chat format, or configuration behavior. Include commands and results. State any runtime checks that remain necessary. Respond to review with a correction or concrete evidence.

Use Conventional Commits: type(scope): description, for example docs(contributing): explain local validation. Use a meaningful scope, or omit it. Keep the subject concise and imperative. Add a body when the reason or compatibility impact is not obvious.

For vulnerabilities, follow the security reporting instructions. Remove credentials and private data from examples, logs, and screenshots.