Contributing to ChatCops: start here

オープン
#546 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
活発
領域
documentation

調査の方向性

This issue is an onboarding guide, not a request for a specific change. Read CONTRIBUTING.md for setup and checks, then choose an unassigned issue linked from the guide; completion should be defined by that issue rather than this one.

索引モデルが issue の本文から書いたものです。

説明

Welcome! ChatCops is an embeddable AI chat widget, a server package and a docs site, and contributions are welcome all year. This is the quickest way in.

Find something to work on

  • Unassigned good first issues are small and well scoped. Good for a first PR.
  • Unassigned help wanted issues are a bit bigger.
  • Nothing open that suits you? Comment here and say what you'd like to work on (widget, server, docs, tests), and I'll find or open one.
  • Found a bug or have an idea? Open an issue first, so we agree on it before you write code.

How it works

  1. Comment on the issue you want. I'll assign it to you, usually within a day. Please don't start on one that's assigned to someone else.
  2. One issue at a time. Once you've had 3 PRs merged with us, you can hold two.
  3. Branch off dev, open your PR against dev, and put Closes #<issue number> in the description.
  4. If there's no PR or update 5 days after you're assigned, I'll free the issue up for someone else. Comment if you need more time.

Setup
This is a pnpm workspace (npm won't work), and you need to run pnpm -r build before pnpm test. CONTRIBUTING.md covers the rest: the checks to run before a PR (pnpm test:coverage, pnpm lint, pnpm size, pnpm docs:check), changesets, and the API snapshot.

What gets merged
PRs linked to an issue, with tests for what they change, and the PR template filled in. PRs that only reformat code, or change things nobody asked for, get closed. Merged PRs get the codercops-accepted label and count on the CoderCops monthly leaderboard at oss.codercops.com.

AI tools
AI tools are fine, but say so in the PR (the template has an "AI assistance" line) and be ready to explain every line.

主要言語
TypeScript
スター
13
フォーク
7
平均マージ
3時間 15分
マージ済み PR(30日)
330

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

codercops/chatcops のほかの issue

codercops/chatcops の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。