Skip to content

Commit 85e2ccb

Browse files
lwjohnst86lwjohnst86
authored
docs: 📝 update README and other general details from template (#84)
# Description Added things from the template. No review needed.
1 parent e1b5bd4 commit 85e2ccb

File tree

11 files changed

+287
-9
lines changed

11 files changed

+287
-9
lines changed

‎.copier-answers.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
2+
_commit: 0.17.10
3+
_src_path: gh:seedcase-project/template-website
4+
author_family_name: Johnston
5+
author_given_name: Luke
6+
github_board_number: '18'
7+
github_repo: guidebook
8+
github_user: seedcase-project
9+
hosting_provider: netlify
10+
is_seedcase_website: true
11+
review_team: '@seedcase-project/developers'

‎.zenodo.json‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"creators": [
3+
{
4+
"name": "Johnston, Luke",
5+
"affiliation": "Steno Diabetes Center Aarhus",
6+
"orcid": "https://orcid.org/0000-0003-4169-2616"
7+
},
8+
{
9+
"name": "Brødbæk, Signe Kirk",
10+
"affiliation": "Steno Diabetes Center Aarhus",
11+
"orcid": "https://orcid.org/0009-0000-2208-7088"
12+
},
13+
{
14+
"name": "Beicher, Kristiane",
15+
"affiliation": "Steno Diabetes Center Aarhus",
16+
"orcid": "https://orcid.org/0000-0001-7556-9566"
17+
},
18+
{
19+
"name": "Vago, Marton",
20+
"affiliation": "Steno Diabetes Center Aarhus",
21+
"orcid": "https://orcid.org/0009-0007-4628-655X"
22+
}
23+
],
24+
"title": "Guidebook to doing research software engineering in a team-setting",
25+
"description": "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. See our website at https://guidebook.seedcase-project.org/ for more details.",
26+
"access_right": "open",
27+
"related_identifiers": [
28+
{
29+
"identifier": "https://github.com/seedcase-project/guidebook",
30+
"relation": "isIdenticalTo",
31+
"resource_type": "other"
32+
}
33+
],
34+
"keywords": [
35+
"quarto website",
36+
"guidebook",
37+
"research software engineering",
38+
"teamwork",
39+
"best practices",
40+
"collaboration"
41+
],
42+
"license": "cc-by-4.0",
43+
"upload_type": "publication",
44+
"publication_type": "other",
45+
"language": "eng"
46+
}

‎404.qmd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "You’ve entered the garden of missing pages"
2+
title: "You've entered the garden of missing pages"
33
---
44

55
Let's get you back to greener grounds.

‎README.md‎

Lines changed: 88 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,90 @@
1-
# Guidebook
21

3-
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/seedcase-project/seedcase-sprout/main.svg)](https://results.pre-commit.ci/latest/github/seedcase-project/seedcase-sprout/main)
42

5-
This repo is ...
3+
# guidebook: Doing research software engineering in a team-setting
4+
5+
<!-- TODO: Include DOI after uploading -->
6+
7+
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)
8+
[![GitHub
9+
License](https://img.shields.io/github/license/seedcase-project/guidebook.svg)](https://github.com/seedcase-project/guidebook/blob/main/LICENSE.md)
10+
[![GitHub
11+
Release](https://img.shields.io/github/v/release/seedcase-project/guidebook.svg)](https://github.com/seedcase-project/guidebook/releases/latest)
12+
[![Build
13+
website](https://github.com/seedcase-project/guidebook/actions/workflows/build-website.yml/badge.svg)](https://github.com/seedcase-project/guidebook/actions/workflows/build-website.yml)
14+
[![pre-commit.ci
15+
status](https://results.pre-commit.ci/badge/github/seedcase-project/guidebook/main.svg)](https://results.pre-commit.ci/latest/github/seedcase-project/guidebook/main)
16+
[![lifecycle](https://lifecycle.r-lib.org/articles/figures/lifecycle-experimental.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
17+
[![Project Status: WIP – Initial development is in progress, but there
18+
has not yet been a stable, usable release suitable for the
19+
public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
20+
<!-- [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) -->
21+
22+
This repository documents the practices, guidelines, and conventions
23+
that we’ve learned and applied that help us develop and release research
24+
software more effectively as solo developers and as a team.
25+
26+
> [!TIP]
27+
>
28+
> This website repository was generated from the
29+
> [`template-website`](https://github.com/seedcase-project/template-website)
30+
> Seedcase template :tada:
31+
32+
## Project files and folders
33+
34+
- `.copier-answers.yml`: Contains the answers you gave when copying the
35+
project from the template. **You should not modify this file
36+
directly.**
37+
- `.cz.toml`:
38+
[Commitizen](https://commitizen-tools.github.io/commitizen/)
39+
configuration file for managing versions and changelogs.
40+
- `.pre-commit-config.yaml`: [Pre-commit](https://pre-commit.com/)
41+
configuration file for managing and running checks before each commit.
42+
- `.typos.toml`: [typos](https://github.com/crate-ci/typos) spell
43+
checker configuration file.
44+
- `.zenodo.json`: Structured citation metadata for your project when
45+
archived on [Zenodo](https://zenodo.org/). This is used to add the
46+
metadata to Zenodo when a GitHub release has been uploaded to Zenodo.
47+
- `justfile`: [`just`](https://just.systems/man/en/) configuration file
48+
for scripting project tasks.
49+
- `.editorconfig`: Editor configuration file for
50+
[EditorConfig](https://editorconfig.org/) to maintain consistent
51+
coding styles across different editors and IDEs.
52+
- `CHANGELOG.md`: Changelog file for tracking changes in the project.
53+
- `CONTRIBUTING.md`: Guidelines for contributing to the project.
54+
- `.github/`: Contains GitHub-specific files, such as issue and pull
55+
request templates, workflows,
56+
[dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
57+
configuration, pull request templates, and a
58+
[CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
59+
file.
60+
- `_metadata.yml`: Quarto metadata file for the website, including
61+
information about the project, such as the titles and GitHub names.
62+
- `_quarto.yml`: Quarto configuration file for the website, including
63+
settings for the website, such as the theme, navigation, and other
64+
options.
65+
66+
## Contributing
67+
68+
Check out our [contributing document](CONTRIBUTING.md) for information
69+
on how to contribute to the project, including how to set up your
70+
development environment.
71+
72+
Please note that this project is released with a [Contributor Code of
73+
Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
74+
to abide by its terms.
75+
76+
### Contributors
77+
78+
The following people have contributed to this project by submitting pull
79+
requests :tada:
80+
81+
[@lwjohnst86](https://github.com/lwjohnst86),
82+
[@signekb](https://github.com/signekb)
83+
84+
## Licensing
85+
86+
This project is licensed under the [CC-BY-4.0 License](LICENSE.md).
87+
88+
## Changelog
89+
90+
For a list of changes, see our [changelog](CHANGELOG.md) page.

‎README.qmd‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
format: gfm
3+
metadata-files:
4+
- _metadata.yml
5+
---
6+
7+
# {{< meta gh.repo >}}: Doing research software engineering in a team-setting
8+
9+
{{< include /includes/_badges.qmd >}}
10+
11+
This repository documents the practices, guidelines, and conventions
12+
that we've learned and applied that help us develop and release research
13+
software more effectively as solo developers and as a team.
14+
15+
::: callout-tip
16+
This website repository was generated from the
17+
[`template-website`](https://github.com/seedcase-project/template-website)
18+
Seedcase template :tada:
19+
:::
20+
21+
## Project files and folders
22+
23+
- `.copier-answers.yml`: Contains the answers you gave when copying
24+
the project from the template. **You should not modify this file
25+
directly.**
26+
- `.cz.toml`:
27+
[Commitizen](https://commitizen-tools.github.io/commitizen/)
28+
configuration file for managing versions and changelogs.
29+
- `.pre-commit-config.yaml`: [Pre-commit](https://pre-commit.com/)
30+
configuration file for managing and running checks before each
31+
commit.
32+
- `.typos.toml`: [typos](https://github.com/crate-ci/typos) spell
33+
checker configuration file.
34+
- `.zenodo.json`: Structured citation metadata for your project when
35+
archived on [Zenodo](https://zenodo.org/). This is used to add the
36+
metadata to Zenodo when a GitHub release has been uploaded to
37+
Zenodo.
38+
- `justfile`: [`just`](https://just.systems/man/en/) configuration
39+
file for scripting project tasks.
40+
- `.editorconfig`: Editor configuration file for
41+
[EditorConfig](https://editorconfig.org/) to maintain consistent
42+
coding styles across different editors and IDEs.
43+
- `CHANGELOG.md`: Changelog file for tracking changes in the project.
44+
- `CONTRIBUTING.md`: Guidelines for contributing to the project.
45+
- `.github/`: Contains GitHub-specific files, such as issue and pull
46+
request templates, workflows,
47+
[dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
48+
configuration, pull request templates, and a
49+
[CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
50+
file.
51+
- `_metadata.yml`: Quarto metadata file for the website, including
52+
information about the project, such as the titles and GitHub names.
53+
- `_quarto.yml`: Quarto configuration file for the website, including
54+
settings for the website, such as the theme, navigation, and other
55+
options.
56+
57+
## Contributing
58+
59+
Check out our [contributing document](CONTRIBUTING.md) for information
60+
on how to contribute to the project, including how to set up your
61+
development environment.
62+
63+
Please note that this project is released with a [Contributor Code of
64+
Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
65+
to abide by its terms.
66+
67+
### Contributors
68+
69+
{{< include /includes/_contributors.qmd >}}
70+
71+
## Licensing
72+
73+
This project is licensed under the [CC-BY-4.0 License](LICENSE.md).
74+
75+
## Changelog
76+
77+
For a list of changes, see our [changelog](CHANGELOG.md) page.

‎_metadata.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
gh:
2+
repo: guidebook
3+
org: seedcase-project

‎_quarto.yml‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,23 @@ project:
44

55
book:
66
title: "Guidebook to doing research software engineering in a team-setting"
7-
subtitle: "A living document for how we work in the Seedcase project"
7+
subtitle: "A living document for how we work and build things in the Seedcase project"
88
search:
99
type: textbox
1010
favicon: _extensions/seedcase-project/seedcase-theme/favicon/favicon.ico
1111
author:
12-
- "Luke W. Johnston"
13-
- "Signe Kirk Brødbæk"
14-
- "Kristiane Beicher"
15-
- "Marton Vago"
12+
- name: "Luke W. Johnston"
13+
affiliation: "Steno Diabetes Center Aarhus"
14+
orcid: "https://orcid.org/0000-0003-4169-2616"
15+
- name: "Signe Kirk Brødbæk"
16+
affiliation: "Steno Diabetes Center Aarhus"
17+
orcid: "https://orcid.org/0009-0000-2208-7088"
18+
- name: "Kristiane Beicher"
19+
affiliation: "Steno Diabetes Center Aarhus"
20+
orcid: "https://orcid.org/0000-0001-7556-9566"
21+
- name: "Marton Vago"
22+
affiliation: "Steno Diabetes Center Aarhus"
23+
orcid: "https://orcid.org/0009-0007-4628-655X"
1624
date: last-modified
1725
repo-url: "https://github.com/seedcase-project/guidebook"
1826
site-url: "https://guidebook.seedcase-project.org/"

‎includes/_badges.qmd‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- TODO: Include DOI after uploading -->
2+
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)
3+
[![GitHub License](https://img.shields.io/github/license/{{< meta gh.org >}}/{{< meta gh.repo >}}.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/blob/main/LICENSE.md)
4+
[![GitHub Release](https://img.shields.io/github/v/release/{{< meta gh.org >}}/{{< meta gh.repo >}}.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/releases/latest)
5+
[![Build website](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-website.yml/badge.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-website.yml)
6+
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/{{< meta gh.org >}}/{{< meta gh.repo >}}/main.svg)](https://results.pre-commit.ci/latest/github/{{< meta gh.org >}}/{{< meta gh.repo >}}/main)
7+
[![lifecycle](https://lifecycle.r-lib.org/articles/figures/lifecycle-experimental.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
8+
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
9+
<!-- [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) -->

‎includes/_contributors.qmd‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
The following people have contributed to this project by submitting pull requests :tada:
2+
3+
[\@lwjohnst86](https://github.com/lwjohnst86), [\@signekb](https://github.com/signekb)

‎index.qmd‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Welcome!
22

3+
{{< include /includes/_badges.qmd >}}
4+
35
Guidebook is about...
46

57
## Who you are as the reader
@@ -11,3 +13,17 @@ think will read the documents:
1113
- **Research software/data engineers**: ...
1214
- **Managers or leaders**: ...
1315
- **Research or development operations personnel**: ...
16+
17+
## Contributing
18+
19+
Check out our [contributing document](CONTRIBUTING.md) for information
20+
on how to contribute to the project.
21+
22+
### Contributors
23+
24+
{{< include /includes/_contributors.qmd >}}
25+
26+
## Changes
27+
28+
Check out our [changelog](CHANGELOG.md) for information on what has
29+
changed in each version of the guidebook.

0 commit comments

Comments
 (0)