markdowneditor

Contributing

CONTRIBUTING – setup, workflow, gates

소프트웨어 및 엔지니어링표준contributing

사용법: Public repos. The "run the gates" section saves review rounds.

미리보기

Contributing

Thanks for your interest in contributing. This document explains how to set up the project and submit changes.

Development setup

git clone https://github.com/you/project.git
cd project
pnpm install
pnpm dev

Workflow

  1. Fork the repo and create a branch from main: feat/my-change
  2. Make your change; follow existing code style
  3. Run the gates before pushing:
pnpm typecheck && pnpm lint && pnpm test && pnpm build
  1. Open a pull request with:
    • What changed and why
    • How you tested it
    • Screenshots for UI changes

Commit style

Conventional commits: feat:, fix:, docs:, refactor:, test:, chore: – with a short imperative summary.

Code review

  • All PRs need one approval
  • Keep PRs focused; one concern per PR
  • Respond to review comments within a few days

Reporting bugs

Open an issue with: steps to reproduce, expected vs actual behavior, browser/OS, and screenshots or console errors.

License

By contributing you agree your work is licensed under the project's license (MIT).

관련 템플릿