Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
28 lines (20 loc) 路 1.2 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) 路 1.2 KB
Raw

Contributing to DocB

We love your input! We want to make contributing to DocB as easy and transparent as possible.

The Pull Request Process

  1. Fork the repo and create your branch from main.
  2. Create a new branch
    • fix/name for bug fixes
    • feat/name for new features
    • docs/name for documentation changes
    • test/name for test changes
    • refactor/name for refactoring
  3. Please write clean, readable code. We have yet to add tests, but writing testable code will make testing easier.
  4. If you change any API surfaces, update the documentation (see Documentation Standards).
  5. Confirm that the project builds locally via Xcode.
  6. Submit your pull request and wait for review!

馃摉 Documentation Standards

We adhere to the standard Apple DocC format for our code documentation. Whenever you introduce new structures or change APIs, please ensure you update the documentation comments accordingly. AI coding assistants should reference their specialized directives in AGENTS.md for precise syntactic placement guidelines.

License

By contributing to DocB, you agree that your contributions will be licensed under its open-source license.