AlexandriaChemistry/ACT

Code cleaning and documentation

Aperta

#1290 aperta il 5 apr 2026

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C++ (2 fork)auto 404
documentationenhancementgood first issuehelp wantedstyle

Metriche repository

Star
 (17 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Inizia selezionando un singolo compito dalla lista (ad esempio, issue #11 o #1207). Quindi esplora i file sorgente pertinenti, comprendi il codice corrente e pianifica la rimozione o il refactoring. Presta attenzione a eventuali dipendenze da altre parti del codice.
Tech stack
cpp
Dominio
documentation
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitC++
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30