euroargodev/software_guidelines

View on GitHub

Argo software development guidelines

Stars: 0
Forks: 0
Open beginner issues: 0
Indexed issues: 59

Dominant language: Python
License: EUPL-1.2
Last GitHub push: Jun 16, 2026
Latest indexed: Sep 15, 2026
Contributing guide: No contributing guide
Code of conduct: No code of conduct
Beginner labels: No beginner labels indexed
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

59 open issues indexed

The project has a long-term sustainability plan Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 25/100

euroargodev/software_guidelines#68 · Opened May 26, 2026
The project uses public communication channels to publish news and updates Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 42/100

euroargodev/software_guidelines#67 · Opened May 6, 2026
The project includes a basic description of what it does with or to the Argo dataset (e.g. read index file, calibrate salinity, plot trajectory, assess BGC variables,...) Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 42/100

euroargodev/software_guidelines#66 · Opened Jul 10, 2025
User meetings or workshops are held and communicated within the Argo community Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 15/100

euroargodev/software_guidelines#63 · Opened Jul 3, 2025
Unit tests cover multiple operating systems Open

guideline

Difficulty 3/5 1-2 days Newbie friendliness 52/100

euroargodev/software_guidelines#62 · Opened Jul 3, 2025
There is a published paper associated with the software (e.g. JOSS article) Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 25/100

euroargodev/software_guidelines#61 · Opened Jul 3, 2025
The software uses an open-source programming language Open

auto-checked-guideline guideline

Difficulty 3/5 1-2 days Newbie friendliness 35/100

euroargodev/software_guidelines#59 · 1 comment · Opened Jul 3, 2025
The software should use a programming language adopted by the Argo community (Python, R, Java, Julia, Matlab/Octave) Open

auto-checked-guideline guideline

Difficulty 5/5 Over a week Newbie friendliness 25/100

euroargodev/software_guidelines#58 · Opened Jul 3, 2025
The software provides a clear description of its dependencies Open

auto-checked-guideline guideline

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

euroargodev/software_guidelines#57 · Opened Jul 3, 2025
The software is released under an open-source license Open

auto-checked-guideline guideline

Difficulty 1/5 Under an hour Newbie friendliness 45/100

euroargodev/software_guidelines#56 · 1 comment · Opened Jul 3, 2025
The software is registered in at least one public software registry (e.g., Zenodo, Seanoe, Research Software Directory) Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 20/100

euroargodev/software_guidelines#55 · Opened Jul 3, 2025
The software is registered in an Argo software registry (AST or Argo-BGC dedicated webpages) Open

guideline

Difficulty 1/5 Under an hour Newbie friendliness 70/100

euroargodev/software_guidelines#54 · Opened Jul 3, 2025
The software is distributed via well-known services (e.g., pip or conda for Python) Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

euroargodev/software_guidelines#53 · Opened Jul 3, 2025
The software is tested and implements continuous integration Open

guideline

Difficulty 3/5 1-2 days Newbie friendliness 35/100

euroargodev/software_guidelines#52 · Opened Jul 3, 2025
The software ensures timely distribution of updates Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 25/100

euroargodev/software_guidelines#51 · Opened Jul 3, 2025
The software has been presented to an Argo community Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

euroargodev/software_guidelines#50 · Opened Jul 3, 2025
The software has a unique persistent identifier (e.g. DOI, SWHID) Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 55/100

euroargodev/software_guidelines#49 · 1 comment · Opened Jul 3, 2025
The software documentation is hosted on the web Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 30/100

euroargodev/software_guidelines#48 · Opened Jul 3, 2025
The software documentation includes usage guidelines and examples Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 25/100

euroargodev/software_guidelines#47 · Opened Jul 3, 2025
The software documentation includes the list of operating systems supported Open

guideline

Difficulty 3/5 1-2 days Newbie friendliness 48/100

euroargodev/software_guidelines#46 · Opened Jul 3, 2025
The software documentation includes the list of changes to the codebase between each software releases Open

auto-checked-guideline guideline

Difficulty 2/5 1-3 hours Newbie friendliness 42/100

euroargodev/software_guidelines#45 · Opened Jul 3, 2025
The software documentation includes the definition of the execution environment(s) supported Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 38/100

euroargodev/software_guidelines#44 · Opened Jul 3, 2025
The software documentation includes installation guidelines Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 55/100

euroargodev/software_guidelines#43 · Opened Jul 3, 2025
The software documentation has an API reference section automatically generated Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 25/100

euroargodev/software_guidelines#42 · Opened Jul 3, 2025
The Project uses English as a primary language (eg: in documentation, codebase) Open

auto-checked-guideline guideline

Difficulty 2/5 1-3 hours Newbie friendliness 25/100

euroargodev/software_guidelines#41 · Opened Jul 3, 2025
The project is hosted on an Argo-recognised web-based development platform Open

auto-checked-guideline guideline

Difficulty 3/5 1-2 days Newbie friendliness 25/100

euroargodev/software_guidelines#40 · 1 comment · Opened Jul 3, 2025
The project is hosted on a web-based development platform (e.g., GitHub or GitLab). Open

auto-checked-guideline guideline

Difficulty 1/5 Under an hour Newbie friendliness 35/100

euroargodev/software_guidelines#39 · 1 comment · Opened Jul 3, 2025
The project includes a document describing how to contribute Open

auto-checked-guideline guideline

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

euroargodev/software_guidelines#38 · Opened Jul 3, 2025
The project includes a basic documentation Open

auto-checked-guideline guideline

Difficulty 2/5 1-3 hours Newbie friendliness 30/100

euroargodev/software_guidelines#36 · Opened Jul 3, 2025
The project include a CITATION.cff file to indicate how to cite the software Open

auto-checked-guideline guideline

Difficulty 2/5 1-3 hours Newbie friendliness 50/100

euroargodev/software_guidelines#32 · 1 comment · Opened Jul 3, 2025
The project has multiple collaborators from the Argo community Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 10/100

euroargodev/software_guidelines#31 · Opened Jul 3, 2025
The project has multiple collaborators from outside the Argo community Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 15/100

euroargodev/software_guidelines#30 · Opened Jul 3, 2025
The project defines expected standards of conduct when engaging in the project (e.g. includes a CODE_OF_CONDUCT file to the codebase) Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 25/100

euroargodev/software_guidelines#29 · Opened Jul 3, 2025
The project clearly list all software identifiers in the README file (e.g. DOI, SWHID) Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 42/100

euroargodev/software_guidelines#28 · Opened Jul 3, 2025
The project allows any user to submit an issue or bug report Open

auto-checked-guideline guideline

Difficulty 1/5 Under an hour Newbie friendliness 25/100

euroargodev/software_guidelines#27 · Opened Jul 3, 2025
The methodology implemented by the software has been presented to an Argo community Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 25/100

euroargodev/software_guidelines#26 · Opened Jul 3, 2025
The codebase is formatted following referenced standards (e.g. black in Python) Open

auto-checked-guideline guideline

Difficulty 4/5 3-5 days Newbie friendliness 35/100

euroargodev/software_guidelines#25 · 1 comment · Opened Jul 3, 2025
The codebase is designed with modular components to facilitate reuse, testing and maintenance Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 25/100

euroargodev/software_guidelines#24 · Opened Jul 3, 2025
The codebase is "consistent", i.e. it follows consistent naming conventions, coding styles, and design patterns throughout the software Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 10/100

euroargodev/software_guidelines#23 · Opened Jul 3, 2025
The codebase includes comments and is documented to explain the purpose and functionality of each module, class, and function Open

guideline

Difficulty 4/5 3-5 days Newbie friendliness 30/100

euroargodev/software_guidelines#22 · Opened Jul 3, 2025
The codebase includes comments and is documented following referenced standards (e.g. numpy style docstrings in Python) Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 25/100

euroargodev/software_guidelines#21 · Opened Jul 3, 2025
Software training sessions are periodically organized Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 20/100

euroargodev/software_guidelines#20 · Opened Jul 3, 2025
Project meetings are periodically organized Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 15/100

euroargodev/software_guidelines#19 · Opened Jul 3, 2025
Non-Argo Data used by the software should be accessible online Open

guideline

Difficulty 3/5 1-2 days Newbie friendliness 35/100

euroargodev/software_guidelines#18 · Opened Jul 3, 2025
Non-Argo Data used by the software are explicitly identified and traceable with a persistent identifier (DOI) when available Open

guideline

Difficulty 4/5 3-5 days Newbie friendliness 20/100

euroargodev/software_guidelines#17 · Opened Jul 3, 2025
Metadata produced by the software follow Argo conventions (as in reference tables provided by the Argo vocabulary server) Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 25/100

euroargodev/software_guidelines#16 · Opened Jul 3, 2025
Issues or bugs are fully documented Open

auto-checked-guideline guideline

Difficulty 3/5 1-2 days Newbie friendliness 35/100

euroargodev/software_guidelines#15 · 1 comment · Opened Jul 3, 2025
Every significant change within the code is managed through a pull request Open

auto-checked-guideline guideline

Difficulty 3/5 1-2 days Newbie friendliness 15/100

euroargodev/software_guidelines#12 · 1 comment · Opened Jul 3, 2025
Each pull request is reviewed by at least one collaborator Open

guideline

Difficulty 5/5 Over a week Newbie friendliness 15/100

euroargodev/software_guidelines#11 · Opened Jul 3, 2025
Each collaborator is clearly identified within the project Open

guideline

Difficulty 2/5 1-3 hours Newbie friendliness 52/100

euroargodev/software_guidelines#10 · Opened Jul 3, 2025

euroargodev/software_guidelines

Get new issues in your inbox