33## :bug : Issues and bugs
44
55The easiest way to contribute is to report issues or bugs that you might
6- find while using ` template-python-package ` . You can do this by creating
7- a
8- [ new] ( https://github.com/seedcase-project/template-python-package/issues/new/choose )
9- issue on our GitHub repository.
6+ find while using template-python-package. You can do this by creating a
7+ new issue on our GitHub repository.
108
119## :pencil2 : Adding or modifying content
1210
@@ -22,12 +20,13 @@ justfile to manage our project, such as to run checks and test the
2220template. Both the uv and justfile websites have a more detailed guide
2321on using uv, but below are some simple instructions to get you started.
2422
25- It's easiest to install uv and justfile using
26- [ pipx] ( https://pipx.pypa.io/stable/ ) , so install that first. Then,
27- install uv and justfile by running:
23+ It's easiest to first
24+ [ install uv] ( https://docs.astral.sh/uv/getting-started/installation/ )
25+ and then install justfile with uv. Once you've installed uv, install
26+ justfile by running:
2827
2928``` bash
30- pipx install uv rust-just
29+ uv tool install rust-just
3130```
3231
3332We keep all our development workflows in the ` justfile ` , so you can
@@ -46,18 +45,63 @@ a terminal so that the working directory is the root of this project
4645just run-all
4746```
4847
49- When testing the template, copier can only use content kept in the Git
48+ When testing the template, Copier can only use content kept in the Git
5049history. Meaning that if you make changes to the template and try to
5150test it, it won't be able to test those changes. You have to commit the
52- changes first in order for copier to use them.
51+ changes first in order for Copier to use them.
5352
5453When committing changes, please try to follow
5554[ Conventional Commits] ( https://decisions.seedcase-project.org/why-conventional-commits/ )
5655as Git messages. Using this convention allows us to be able to
5756automatically create a release based on the commit message by using
5857[ Commitizen] ( https://decisions.seedcase-project.org/why-semantic-release-with-commitizen/ ) .
5958If you don't use Conventional Commits when making a commit, we will
60- revise the pull request title to follow that format, as we use
61- [ squash merges] ( https://git-scm.com/docs/git-merge ) when merging pull
62- requests, when merging pull requests, so all other commits in the pull
59+ revise the pull request title to follow that format, as we use squash
60+ merges when merging pull requests, so all other commits in the pull
6361request will be squashed into one commit.
62+
63+ ## :file_folder : Explanation of files and folders
64+
65+ This list describes the default files that are included in the template
66+ as well as explains a bit more about them and what they are used for.
67+
68+ - ` .copier-answers.yml ` : Contains the answers you gave when copying the
69+ project from the template.
70+ ** You should not modify this file directly.**
71+ - ` .github/ ` : Contains GitHub-specific files, such as the workflow to
72+ build the website from the Markdown files.
73+ - ` _quarto.yml ` : Quarto configuration file for the website, including
74+ settings for the website, such as the theme, navigation, and other
75+ options.
76+ - ` .gitignore ` : This ignore file tells Git which files to not track.
77+ Unless you know what you are doing, it's best to not touch this file.
78+ - ` .pre-commit-config.yaml ` : [ Pre-commit] ( https://pre-commit.com/ )
79+ configuration file for managing and running checks before each commit.
80+ - ` .typos.toml ` : [ typos] ( https://github.com/crate-ci/typos ) spell
81+ checker configuration file.
82+ - ` CITATION.cff ` : Structured citation metadata for your project when
83+ archived on [ Zenodo] ( https://zenodo.org/ ) and used by GitHub to
84+ display the citation information on the repository page. This is used
85+ to add the metadata to Zenodo when a GitHub release has been uploaded
86+ to Zenodo.
87+ - ` justfile ` : [ ` just ` ] ( https://just.systems/man/en/ ) configuration file
88+ for scripting project tasks.
89+ - ` .editorconfig ` : Editor configuration file for
90+ [ EditorConfig] ( https://editorconfig.org/ ) to maintain consistent
91+ coding styles across different editors and IDEs.
92+ - ` CHANGELOG.md ` : Changelog file for tracking changes in the project.
93+ - ` CONTRIBUTING.md ` : Guidelines for contributing to the project.
94+ - ` .github/ ` : Contains GitHub-specific files, such as issue and pull
95+ request templates, workflows,
96+ [ dependabot] ( https://docs.github.com/en/code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide )
97+ configuration, pull request templates, and a
98+ [ CODEOWNERS] ( https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners )
99+ file.
100+ - ` _metadata.yml ` : Quarto metadata file for the website, including
101+ information about the project, such as the titles and GitHub names.
102+ - ` .rumdl.toml ` : [ rumdl] ( https://rumdl.dev ) configuration file for
103+ formatting Markdown files in the project.
104+ - ` cog.toml ` : [ Cocogitto] ( https://docs.cocogitto.io ) configuration file
105+ for managing versions.
106+ - ` .config/cliff.toml ` : [ git-cliff] ( https://git-cliff.org ) configuration
107+ file for creating the changelog.
0 commit comments