Contributing to ChatCops: start here

Ouverte
#546 5 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
À clarifier
Activité
Active
Domaine
documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
TypeScript
Étoiles
13
Forks
7
Merge moyen
3 h 15 min
PR mergées (30 j)
330

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de codercops/chatcops

Toutes les issues de codercops/chatcops

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.