docs: add HELP and CONTRIBUTING guides

kangeunchan · kangeunchan · commit 5d06c00ee2a7 · 2026-01-20T20:09:38.000+09:00
- Add HELP.md with template usage instructions
  - Add CONTRIBUTING.md with contribution guidelines
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,86 @@
+# Contributing
+
+Thank you for considering contributing to this project!
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork
+3. Create a new branch for your changes
+
+## Development Workflow
+
+### Code Style
+
+- Follow the official [Kotlin coding conventions](https://kotlinlang.org/docs/coding-conventions.html)
+- Use 4 spaces for indentation
+- Keep lines under 120 characters when possible
+
+### Testing
+
+All changes must include appropriate tests:
+
+```bash
+bazel test //...
+```
+
+Ensure all tests pass before submitting a pull request.
+
+### Building
+
+```bash
+bazel build //...
+```
+
+## Commit Guidelines
+
+We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
+
+```
+<type>: <subject>
+
+<body>
+
+<footer>
+```
+
+### Types
+
+- `feat`: A new feature
+- `fix`: A bug fix
+- `refactor`: Code change that neither fixes a bug nor adds a feature
+- `test`: Adding or updating tests
+- `docs`: Documentation changes
+- `chore`: Changes to build process or tooling
+
+### Examples
+
+```
+feat: add support for custom annotations in allopen plugin
+
+This change allows users to specify custom annotations for the
+Spring allopen plugin configuration.
+```
+
+```
+fix: resolve JUnit version mismatch in test dependencies
+
+Updates test imports to use JUnit 4 to match the declared
+dependency in MODULE.bazel.
+```
+
+## Pull Request Process
+
+1. Update documentation if needed
+2. Ensure all tests pass
+3. Update the changelog if applicable
+4. Submit your pull request with a clear description of changes
+5. Wait for review and address any feedback
+
+## Code Review
+
+All submissions require review. We use GitHub pull requests for this purpose.
+
+## Questions?
+
+Feel free to open an issue for any questions or concerns.
diff --git a/HELP.md b/HELP.md
@@ -0,0 +1,94 @@
+# Help
+
+## Prerequisites
+
+- [Bazelisk](https://github.com/bazelbuild/bazelisk) (recommended) or Bazel 7.0+
+- JDK 17 or higher
+
+## Creating a New Module
+
+1. Create the module directory structure:
+```bash
+mkdir -p module-name/src/main/kotlin
+mkdir -p module-name/src/test/kotlin
+```
+
+2. Create `module-name/deps.bzl`:
+```bzl
+MODULE_DEPS = [
+    "@maven//:org_springframework_boot_spring_boot_starter_web",
+]
+
+TEST_DEPS = [
+    "@maven//:junit_junit",
+]
+```
+
+3. Create `module-name/BUILD.bazel`:
+```bzl
+load("@rules_kotlin//kotlin:jvm.bzl", "kt_jvm_binary", "kt_jvm_test")
+load("//:kotlin.bzl", "setup_kotlin_compiler", "setup_spring_allopen_plugin")
+load("//module-name:deps.bzl", "MODULE_DEPS", "TEST_DEPS")
+
+package(default_visibility = ["//visibility:public"])
+
+setup_kotlin_compiler()
+setup_spring_allopen_plugin()
+
+kt_jvm_binary(
+    name = "main",
+    srcs = glob(["src/main/kotlin/**/*.kt"]),
+    main_class = "hs.kr.entrydsm.example.MainKt",
+    plugins = ["//:spring_allopen"],
+    deps = MODULE_DEPS,
+    javac_opts = "//:javac_options",
+    kotlinc_opts = "//:kotlinc_options",
+)
+
+kt_jvm_test(
+    name = "test",
+    srcs = glob(["src/test/kotlin/**/*.kt"]),
+    test_class = "hs.kr.entrydsm.example.TestClass",
+    plugins = ["//:spring_allopen"],
+    deps = MODULE_DEPS + TEST_DEPS,
+    javac_opts = "//:javac_options",
+    kotlinc_opts = "//:kotlinc_options",
+)
+```
+
+## Adding Dependencies
+
+1. Add the Maven artifact to `MODULE.bazel`:
+```bzl
+maven.artifact(
+    artifact = "artifact-name",
+    group = "group.id",
+    version = VERSION_CONSTANT,
+)
+```
+
+2. Add the dependency to your module's `deps.bzl`:
+```bzl
+MODULE_DEPS = [
+    "@maven//:group_id_artifact_name",
+]
+```
+
+## Building and Testing
+
+```bash
+# Build all targets
+bazel build //...
+
+# Run all tests
+bazel test //...
+
+# Run a specific module
+bazel run //module-name:main
+```
+
+## Getting Help
+
+- [Bazel Documentation](https://bazel.build/docs)
+- [rules_kotlin Documentation](https://github.com/bazelbuild/rules_kotlin)
+- [Issue Tracker](../../issues)
