Review with Carpentries Style Guide

Offen
#120 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Start with the Carpentries style guide and choose one unchecked episode from the listed lesson sections, such as Summary and Setup or Variables and Types. Review that episode for style and consistency, then comment with suggested changes or submit a focused pull request for the episode and mark it reviewed when the changes are complete.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

good first issue help wanted
How could the content be improved?

Following a major lesson redesign on June 17, 2024, it would be helpful if contributors reviewed specific episodes for style issues using the Carpentries style guide. The authors and maintainers of the updated lesson followed the guide, in general, but haven't reviewed each episode closely for style or consistency.

Contributors hoping to help out can comment on this issue with suggested changes. More experienced community members are welcome to submit PRs for specific episodes (one at a time) and assign @chennesy as a Reviewer. I will track progress here and check off episodes once they have been reviewed for style:

  • Summary and Setup
  • Getting Started
  • Variables and Types
  • Lists
  • Built-in Functions and Help
  • Libraries & Pandas
  • For Loops
  • Looping Over Data Sets
  • Using Pandas
  • Conditionals
  • Writing Functions
  • Tidy Data with Pandas
  • Data Visualisation
  • Wrap-Up
Vorherrschende Sprache
HTML
Sterne
25
Forks
65
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

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 LibraryCarpentry/lc-python-intro

Alle Issues in LibraryCarpentry/lc-python-intro

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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