|
| 1 | +# Welcome! |
| 2 | + |
| 3 | +{{< include /docs/includes/_badges.qmd >}} |
| 4 | + |
| 5 | +This is a template for creating a new workshop with the intent of making |
| 6 | +it an open educational resource (OER). Use this template to quickly get |
| 7 | +started with a new workshop with all the necessary files and |
| 8 | +configurations in place, including for developing the workshop. |
| 9 | + |
| 10 | +## Features |
| 11 | + |
| 12 | +- Uses [Quarto](https://quarto.org/) for the workshop content, |
| 13 | + allowing for easy integration of code, text, and figures. |
| 14 | +- Includes a [justfile](https://just.systems/man/en/) for managing |
| 15 | + common tasks like building the workshop and running checks. |
| 16 | +- Uses [typos](https://github.com/crate-ci/typos) to check for common |
| 17 | + spelling mistakes. |
| 18 | +- For R projects, uses [Air](https://posit-dev.github.io/air/) to |
| 19 | + format and check R code. |
| 20 | +- Uses |
| 21 | + [Commitizen](https://decisions.seedcase-project.org/why-changelog-with-commitizen) |
| 22 | + to |
| 23 | + [check](https://decisions.seedcase-project.org/why-lint-with-commitizen/) |
| 24 | + commit messages and automatically create the changelog. |
| 25 | +- Automated Git tagging and GitHub releases with |
| 26 | + [commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen/) |
| 27 | + that are based on messages following [Conventional |
| 28 | + Commits](https://decisions.seedcase-project.org/why-conventional-commits). |
| 29 | +- Uses a [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) |
| 30 | + license for the workshop content. |
| 31 | +- Run checks with with [pre-commit](https://pre-commit.com/) hooks to |
| 32 | + ensure consistent formatting and style across the project. It |
| 33 | + includes checks for credentials, typos, and file formatting. |
| 34 | +- Uses the |
| 35 | + [`rostools-theme`](https://github.com/rostools/rostools-theme) |
| 36 | + Quarto extension for a standard appearance across workshops. |
| 37 | +- Includes [GitHub Actions](https://docs.github.com/en/actions) for |
| 38 | + continuous integration, testing, and delivery for running checks, |
| 39 | + formatting, releasing, and building the website. |
| 40 | +- Uses [Netlify](https://www.netlify.com/) for hosting the workshop |
| 41 | + website. |
| 42 | +- Includes an [EditorConfig](https://editorconfig.org/) file to ensure |
| 43 | + consistent formatting across different editors. |
| 44 | +- High level, system and program management with |
| 45 | + [uv](https://decisions.seedcase-project.org/why-uv/). |
| 46 | +- GitHub workflows for automatically adding Pull Requests and Issues |
| 47 | + to a project board. |
| 48 | +- Pull Request template for easy creation of new Pull Requests. |
| 49 | +- [VS Code](https://code.visualstudio.com/) settings commonly used by |
| 50 | + contributors working in VS Code. |
| 51 | +- [`.zenodo.json`](https://help.zenodo.org/docs/github/describe-software/zenodo-json/) |
| 52 | + file for citation information, that provides Zenodo with the |
| 53 | + necessary metadata to create a DOI for the workshop. |
| 54 | + |
| 55 | +## Want to contribute? |
| 56 | + |
| 57 | +We would love your feedback or contributions! Head over to our [GitHub |
| 58 | +repository](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}) |
| 59 | +or our [contributing guide](/CONTRIBUTING.md) to share your ideas or |
| 60 | +contribute code. Your input makes us better! |
| 61 | + |
| 62 | +## Contributors |
| 63 | + |
| 64 | +These are the people who have contributed to Sprout by submitting |
| 65 | +changes through pull requests :tada: |
| 66 | + |
| 67 | +{{< include /_contributors.qmd.tmp >}} |
0 commit comments