Contributing to ChatCops: start here

Offen
  • Stimmt etwas nicht?
#546 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Muss geklärt werden
Aktivitätsstatus
Aktiv
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
TypeScript
Sterne
13
Forks
7
Ø Merge
3 Std. 10 Min.
Gemergte PRs (30 T.)
339

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus codercops/chatcops

Alle Issues in codercops/chatcops

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.