guidebook: Doing research software engineering in a team-setting

This repository documents the practices, guidelines, and conventions that we’ve learned and applied that help us develop and release research software more effectively as solo developers and as a team.

Tip

This website repository was generated from the template-website Seedcase template 🎉

Project files and folders

• .copier-answers.yml: Contains the answers you gave when copying the project from the template. You should not modify this file directly.
• .cz.toml: Commitizen configuration file for managing versions and changelogs.
• .pre-commit-config.yaml: Pre-commit configuration file for managing and running checks before each commit.
• .typos.toml: typos spell checker configuration file.
• .zenodo.json: Structured citation metadata for your project when archived on Zenodo. This is used to add the metadata to Zenodo when a GitHub release has been uploaded to Zenodo.
• justfile: just configuration file for scripting project tasks.
• .editorconfig: Editor configuration file for EditorConfig to maintain consistent coding styles across different editors and IDEs.
• CHANGELOG.md: Changelog file for tracking changes in the project.
• CONTRIBUTING.md: Guidelines for contributing to the project.
• .github/: Contains GitHub-specific files, such as issue and pull request templates, workflows, dependabot configuration, pull request templates, and a CODEOWNERS file.
• _metadata.yml: Quarto metadata file for the website, including information about the project, such as the titles and GitHub names.
• _quarto.yml: Quarto configuration file for the website, including settings for the website, such as the theme, navigation, and other options.

Contributing

Check out our contributing document for information on how to contribute to the project, including how to set up your development environment.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributors

The following people have contributed to this project by submitting pull requests 🎉

@lwjohnst86, @signekb

Licensing

This project is licensed under the CC-BY-4.0 License.

Changelog

For a list of changes, see our changelog page.