Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (20 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1 KB
Raw

Contributing

Thanks for helping improve rails_api_keys. This gem stays intentionally thin: keys + auth helpers only. Host apps own UI, routes, and domain APIs.

Development setup

bundle install
bundle exec rspec
bin/rubocop

Specs boot spec/dummy (sqlite). Run both RSpec and RuboCop before opening a PR.

Pull requests

  1. Open an issue first for larger changes so we can agree on scope.
  2. Keep the engine boundary thin — no host UI, mailers, jobs, views, or mounted business routes.
  3. Prefer single quotes and # frozen_string_literal: true on Ruby files.
  4. Add or update RSpec coverage for behavior changes.
  5. Update CHANGELOG.md under [Unreleased] when the public API or user-facing behavior changes.
  6. Update .cursor/rules/context.mdc and AGENTS.md when the public API changes.

Security

Do not report security vulnerabilities in public issues. See SECURITY.md.

Code of conduct

Participation is covered by our Code of Conduct.