Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

README needs refined

Aperta
  • Qualcosa non va?
#27 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
csharp
Ambito
documentation

Direzione di ricerca

Inizia esaminando i titoli di README e le sezioni relative a installazione, utilizzo, offuscamento, indice e crediti. Controlla in CONTRIBUTING.md la destinazione del link e identifica quali dettagli relativi agli esempi e alle funzionalità dovrebbero essere spostati nel Wiki. Il lavoro è completato quando README presenta titoli e contenuti coerenti, indicazioni concise su installazione e utilizzo e il trattamento richiesto per i contributi e i crediti.

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

Descrizione

enhancement good first issue technical debt

Is your feature request related to a problem? Please describe.

I've noticed a couple of issues with the README that make it appear a little clumsy -

  • Installation section is talking about using the sample projects rather than installing the package - the section's content is also formatted more like Wiki than README content
  • The description header is superfluous
  • The table of contents has only one sub-section under Usage (Obfuscation)
  • Obfuscation is actually a header on the same level as Usage, rather than a sub-header as the ToC suggests
  • Usage instructs people to a create a new console app - this is overly prescriptive and not necessary
  • Obfuscation has its own sub-headers that aren't on the ToC
  • Contributing section should point to the CONTRIBUTING.md file
  • Credits section should probably be removed if we're just crediting ourselves

Describe the solution you'd like

  • Correct the installation section to be about installing the package (probably move the detail about the samples to the Wiki as it bloats the README)
  • Remove the description header and put the descriptive text under the title
  • Move obfuscation under usage and shift a considerable amount of this to the Wiki to avoid bloating the README with only specific features
  • Ensure the ToC is reflective of the actual headings
  • Replace the text in the Credits section with something along the lines of "Please refer to the Contributing guide." (with a link)
  • Remove the credits section
Lingua principale
C#
Stelle
27
Fork
11
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

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 Capgemini/xrm-datamigration

Tutte le issue di Capgemini/xrm-datamigration

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.