Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (41 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 1.78 KB

Contributing

Thank you for your interest in contributing to authkit. This guide covers questions, bug reports, feature requests, and pull requests. For private vulnerability reporting, use SECURITY.md instead of public channels.

Asking Questions

Use GitHub Discussions for usage questions, troubleshooting, and general discussion.

Reporting Bugs

Report non-security bugs through GitHub Issues. Include the following details when possible:

  • version, commit, or environment details
  • steps to reproduce
  • expected behavior
  • actual behavior
  • logs, screenshots, or a minimal reproduction

If you are reporting a security issue, stop and follow SECURITY.md instead.

Proposing Features

Use GitHub Discussions for feature requests and design proposals. For larger changes, describe the problem and a small proposed next step before starting implementation.

Pull Requests

Contributors should:

  1. Keep changes focused and scoped to a single problem.
  2. Add or update tests when behavior changes.
  3. Update documentation when user-facing behavior changes.
  4. Describe the change clearly in the pull request.
  5. Make sure CI passes before requesting review.

Local Setup

Install the docs dependencies and run the repository checks:

npm --prefix docs install
moon ci --summary minimal

Useful project commands:

moon run docs:build
moon run docs:start
moon run docs:typecheck

Keep Go tests, linting, and docs checks passing together as the runtime packages grow.

License

Unless stated otherwise, contributions are accepted under the repository's dual license: Apache License 2.0 or MIT, at your option.