Write a first-contribution walkthrough

Aperta Adatta ai principianti
#138 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown, nodejs, typescript

Direzione di ricerca

Inizia leggendo CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md e docs/DEVELOPMENT.md per raccogliere le regole e i passaggi di configurazione che la guida deve coprire. Scrivi docs/FIRST_CONTRIBUTION.md che copra fork, branch, esecuzione, verifica, commit e pull request, con comandi separati per PowerShell e macOS/Linux. Esegui personalmente ogni comando, aggiungi link da CONTRIBUTING.md e dal README, e verifica che i link funzionino.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation good first issue

Difficulty: Beginner · Estimated size: 2 to 4 hours

Context

CONTRIBUTING.md lists the rules, but a first-time contributor also needs the full path from fork to merged pull request.

Problem or goal

Create a friendly guide for people who have never contributed to open source.

Suggested approach

  • Write docs/FIRST_CONTRIBUTION.md: pick an issue (filter by good first issue), claim it, fork, clone, branch, run the app, make a change, run the checks, commit, push and open a pull request, with the exact commands for Windows PowerShell and for macOS or Linux.
  • Explain what to expect from review and how long it takes, and how to update the pull request after feedback.
  • Link it from CONTRIBUTING.md and the README.

Where to look

  • CONTRIBUTING.md
  • .github/PULL_REQUEST_TEMPLATE.md
  • docs/DEVELOPMENT.md

Acceptance criteria

  • Every command in the guide has been run by the author.
  • A beginner can follow it without other help.
  • Links work.

How to work on it

  1. Comment here to claim it, so two people do not do the same work.
  2. Fork the repo and branch from main (feat/short-name or fix/short-name). Setup steps are in docs/DEVELOPMENT.md.
  3. Keep the change focused and add tests for backend logic.
  4. Run npm run typecheck, npm test and npm run lint and npm run format before opening the pull request.
  5. Use a Conventional Commits title (for example feat(web): add bookmarks). More in CONTRIBUTING.md.

Stuck? Ask in this issue. Questions are welcome.


Generated by Claude Code

Lingua principale
TypeScript
Stelle
6
Fork
6
Merge medio
1h 59m
PR unite (30g)
59

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Haseeb-MernStack/commune

Tutte le issue di Haseeb-MernStack/commune

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.