diff options
| author | Sho Sakuma <me@m1sk9.dev> | 2026-01-10 14:09:11 +0900 |
|---|---|---|
| committer | Sho Sakuma <me@m1sk9.dev> | 2026-01-10 14:09:11 +0900 |
| commit | 340eb72a77bca58ebce15280e3f166f2a3b4966d (patch) | |
| tree | 4d8319d7c26529f78a8b2965b24804dd99a2639b /.github | |
| parent | 7f8cc94aaa28340f084f1b700fd07295757df76a (diff) | |
| download | LunaticChat-340eb72a77bca58ebce15280e3f166f2a3b4966d.tar.gz LunaticChat-340eb72a77bca58ebce15280e3f166f2a3b4966d.tar.bz2 LunaticChat-340eb72a77bca58ebce15280e3f166f2a3b4966d.zip | |
docs: Add Contributing guide and Security guide
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 25 | ||||
| -rw-r--r-- | .github/SECURITY.md | 16 |
2 files changed, 41 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..2ff10db --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# LunaticChat Contribution Guidelines + +## Looking for Support? + +For instructions on using LunaticChat, see the [official documentation](https://lc.m1sk9.dev). + +For questions, see the [discussion](https://github.com/m1sk9/LunaticChat/discussions). + +## Reporting Bugs / Requesting Features + +Before reporting a bug or requesting a feature, please search the [issues](). + +If your issue is not already reported, please create a new issue using the provided template. Be sure to include as much detail as possible, including steps to reproduce the issue if applicable. + +## Contributing Code + +We welcome contributions to LunaticChat! + +LuckPerms adheres to the [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html). + +It also uses Ktlint. Merging pull requests into the main branch requires passing Ktlint checks. When submitting a pull request, remember to run `./gradlew ktlintFormat`. + +When making major changes that break backward compatibility, please discuss them beforehand via an issue or discussion. +Such changes often cause confusion when made without prior discussion. + diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..b2a5b43 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,16 @@ +# Security Policy + +## Supported Versions + +LunaticChat only supports the latest version at any given time. +Older versions are not supported, and backports will not be provided unless absolutely necessary. + +### In Minecraft + +The Minecraft version follows the `api-version` on which the latest LunaticChat runs. However, it fundamentally depends on the Paper API / Velocity API version. + +(Example: If the `api-version` is `1.21`, operation on `1.21.X` is guaranteed.) + +## Reporting a Vulnerability + +Do not report security issues using Issues. Please report them by sending an encrypted email to [me@m1sk9.dev](mailto:me@m1sk9.dev). |