euroargodev / euroargodev/software_guidelines
The software documentation includes usage guidelines and examples
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The documentation should include examples of the software features and guidelines on how to use it.
In the early stage of a software project, or for novice and beginners, this guideline is useful to precisely define the application scope of a codebase.
When the software will gain in maturity, and developers in expertise, the documentation will improve accordingly.
It also a good practice that advanced and expert maintainers, or for software seeking a viable, structured, robust (and above) research software maturity level to produce/publish tutorial material (eg: notebooks, presentation, video, etc.).
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.