Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (21 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.13 KB

Contributing to API Documenter

Thank you for your interest in contributing to API Documenter! We welcome contributions from everyone.

How to Contribute

  1. Report Bugs: If you find a bug, please open an issue on GitHub with detailed steps to reproduce.
  2. Suggest Features: Have a great idea? Open an issue to discuss it.
  3. Pull Requests:
    • Fork the repository.
    • Create a new branch for your feature or fix.
    • Write clear, documented code.
    • Submit a pull request with a detailed description of your changes.

Development Setup

  1. Clone your fork.
  2. Run npm install.
  3. Run npm run dev to start the development environment.

📚 Important: Before diving into the codebase, please read our Developer Guide to understand the project architecture, Git integration, and Sync Queue engine.

Style Guidelines

  • Use TypeScript for all new code.
  • Follow existing formatting patterns (ESLint/Prettier rules in the project).
  • Write descriptive commit messages.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.