Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (49 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

74 lines (49 loc) · 3.21 KB

Contributing to NativeAppTemplate API

Thanks for your interest in contributing! This document explains how to report issues, propose changes, and submit pull requests.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold it.

Reporting Bugs

Before opening an issue, please:

  1. Search existing issues to avoid duplicates.
  2. Confirm the bug reproduces on the main branch.
  3. Include:
    • Ruby and Rails versions (ruby -v, bin/rails -v)
    • PostgreSQL version
    • Steps to reproduce
    • Expected vs actual behavior
    • Relevant log output or stack traces

Reporting Security Vulnerabilities

Do not open public issues for security vulnerabilities. See SECURITY.md for the disclosure process.

Proposing Changes

For non-trivial changes, please open an issue first to discuss the approach before investing implementation time.

Pull Requests

  1. Fork the repository and create a feature branch from main.
  2. Make your changes with clear, focused commits.
  3. Add or update tests for any behavioral changes.
  4. Run the full test suite locally: 
    bin/rails test
  5. Run the linter and security scanner: 
    bin/rubocop
bin/brakeman --no-pager
  6. Push your branch and open a pull request against main.
  7. In the PR description, explain what changed and why.

Style

This project uses RuboCop with the Rails Omakase style. Please ensure bin/rubocop passes before submitting.

Tests

  • Tests use Minitest with parallel execution.
  • Place new tests under test/ mirroring the source structure.
  • Use fixtures (test/fixtures/) for test data.
  • Mock external HTTP calls with WebMock.

Rename safety

This substrate is consumed by nativeapptemplate-agent, which mechanically renames Shop, Shopkeeper, and ItemTag (and all their case forms — PascalCase, snake_case, camelCase, flat, UPPER_SNAKE, humanized lower/title/sentence × singular/plural) to user-chosen target words. Some patterns that read fine in this repo break when renamed.

Before merging changes that touch user-facing strings, OpenAPI summaries, test descriptors, or comments mentioning domain entities, read the substrate rename-safety contract.

Quick rule of thumb: avoid "a" / "an" directly preceding Shop, Shopkeeper, or ItemTag (or their humanized forms) — write self-contained or article-free phrasings instead.

Failure mode this prevents: an OpenAPI summary like "Get an item tag" or a test descriptor like test "destroy deletes an item_tag" reads correctly here but produces "Get an patient" / "destroy deletes an patient" after the rename pipeline substitutes a consonant-starting word like Patient.

Development Setup

See README.md for full setup instructions.

License

By contributing, you agree that your contributions will be licensed under the MIT License.