Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (24 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.29 KB
Raw

Contributing to busbar-auth-github

Thanks for your interest in improving busbar-auth-github.

Ground rules

  • Be respectful and constructive in all project spaces (see CODE_OF_CONDUCT.md).
  • By contributing, you agree your contributions are licensed under the project's Apache-2.0 license.
  • Security issues go through SECURITY.md, not public issues.

Layout

Every busbar plugin repo has the same shape. This one is a two-crate Cargo workspace: auth-github/ holds the plugin's logic and auth-github-plugin/ is the thin cdylib that packages it as a droppable kind: auth plugin. busbar itself is a git dependency pinned to the commit in .busbar-ref. The CI, release and lint configuration are rendered from busbar's plugin registry; change them there, not here.

Before you open a pull request

cargo fmt --all -- --check
cargo clippy --workspace --all-targets --locked -- -D warnings
cargo test --workspace --locked

The README's Tests section names any live backend the full suite needs. Add or update tests for any behavior change, and update the README when you change behavior or config. Keep commits focused and describe what changed, why, and how it was verified.