AlexandriaChemistry/ACT

Code cleaning and documentation

Offen

#1.290 geöffnet am 05.04.2026

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (2 Forks)auto 404
documentationenhancementgood first issuehelp wantedstyle

Repository-Metriken

Stars
 (17 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 5h 29m) (15 gemergte PRs in 30 T)

Beschreibung

Obviously this is a never-ending topic, but this is to combine a couple previous issues into one, which can then be closed

  • Issue #11 remove GROMACS history
  • Issue #1207 remove GMX_THROW from code
  • Issue #1163 get rid of const char *
  • Issue #690 more descriptive information to users
  • Issue #389 clean up enum duplication
  • Issue #362 resolve TODO and FIXME
  • Issue #259 print information about compilation
  • Issue #979 communication about incorrect input, e.g. no data to train on
  • Issue #1216
  • Add index to manual.

Contributor Guide

Research-Richtung
Beginnen Sie damit, eine einzelne Aufgabe aus der Liste auszuwählen (z. B. Issue #11 oder #1207). Erkunden Sie dann die relevanten Quelldateien, verstehen Sie den aktuellen Code und planen Sie die Entfernung oder Umstrukturierung. Beachten Sie alle Abhängigkeiten von anderen Teilen des Codes.
Tech Stack
cpp
Domain
documentation
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
GitC++
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30