Skip to content

phac-modelling-hub/dev-practices

Repository files navigation

Best practices for scientific software development

This project contains files to generate the Best practices for scientific software development guide. Authorship information and acknowledgements can be found here.

Reporting issues

If you find issues in the guide, such as typos, formatting/appearance issues, or unclear/missing information, please report them.

For contributors

The guide is a Quarto Website. The files generating the website are index.qmd (home page) and .qmds in subdirectories corresponding to the guide's sections. The website settings are in _quarto.yml. Edit this file to change the appearance of the guide of the navigation elements. Preview the website locally using these instructions.

Publishing the site

The site is built and published automatically via GitHub Actions upon changes to the main branch. The workflow is defined in .github/workflows /publish-site.yml.

About

Best practices for scientific software development

Resources

License

Stars

Watchers

Forks

Contributors

Languages