From ff99f39fd87a81c9b3ca285ea9879d8e455dfaa3 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Thu, 24 Jul 2025 15:21:02 +0200 Subject: [PATCH 1/3] docs: :memo: add CONTRIBUTING file --- CONTRIBUTING.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3216ec3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# Contributing + +## Issues and bugs :bug: + +The easiest way to contribute is to report issues or bugs that you might +find while using `template-data-package`. You can do this by creating a +[new](https://github.com/seedcase-project/template-data-package/issues/new/choose) +issue on our GitHub repository. + +## Adding or modifying content :pencil2: + +If you would like to contribute content, please check out our +[guidebook](https://guidebook.seedcase-project.org/) for more specific +details on how we work and develop. It is a regularly evolving document, +so is at various states of completion. + +To contribute to `template-data-package`, you first need to install +[uv](https://docs.astral.sh/uv/) and +[justfile](https://just.systems/man/en/packages.html). We use uv and +justfile to manage our project, such as to run checks and test the template. +Both the uv and justfile websites have a more detailed guide on +using uv, but below are some simple instructions to get you started. + +To install uv and justfile, run: + +``` bash +pipx install uv rust-just +``` + +We keep all our development workflows in the `justfile`, so you can +explore it to see what commands are available. To see a list of commands +available, run: + +``` bash +just +``` + +As you contribute, make sure your changes will pass our tests by opening a +terminal so that the working directory is the root of this +project (`template-data-package/`) and run: + +``` bash +just run-all +``` From 7fc27b8c04cc858a7d3de552227c67c6062deb14 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Thu, 24 Jul 2025 15:22:06 +0200 Subject: [PATCH 2/3] style: :art: format Markdown --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3216ec3..e41b769 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,9 +17,9 @@ so is at various states of completion. To contribute to `template-data-package`, you first need to install [uv](https://docs.astral.sh/uv/) and [justfile](https://just.systems/man/en/packages.html). We use uv and -justfile to manage our project, such as to run checks and test the template. -Both the uv and justfile websites have a more detailed guide on -using uv, but below are some simple instructions to get you started. +justfile to manage our project, such as to run checks and test the +template. Both the uv and justfile websites have a more detailed guide +on using uv, but below are some simple instructions to get you started. To install uv and justfile, run: @@ -35,9 +35,9 @@ available, run: just ``` -As you contribute, make sure your changes will pass our tests by opening a -terminal so that the working directory is the root of this -project (`template-data-package/`) and run: +As you contribute, make sure your changes will pass our tests by opening +a terminal so that the working directory is the root of this project +(`template-data-package/`) and run: ``` bash just run-all From a4ef24f95ede25af1bb6e4bdbc56bf3990b73e6d Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Thu, 24 Jul 2025 17:13:44 +0200 Subject: [PATCH 3/3] docs: :pencil2: typo fix Co-authored-by: martonvago <57952344+martonvago@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e41b769..9e65786 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,7 @@ just As you contribute, make sure your changes will pass our tests by opening a terminal so that the working directory is the root of this project -(`template-data-package/`) and run: +(`template-data-package/`) and running: ``` bash just run-all