diff --git a/_quarto.yml b/_quarto.yml index fbe4bd0..c72e08f 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -113,6 +113,7 @@ website: - docs/guide/tools/bots.qmd - docs/guide/tools/cdes.qmd - docs/guide/tools/metrics.qmd + - docs/guide/tools/gh-issue-template.qmd format: html: diff --git a/docs/guide/tools/gh-issue-template.qmd b/docs/guide/tools/gh-issue-template.qmd new file mode 100644 index 0000000..6d3deaa --- /dev/null +++ b/docs/guide/tools/gh-issue-template.qmd @@ -0,0 +1,36 @@ +--- +tite: "GitHub issue template" +sidebar: guide +--- + +## GitHub Issue templates + +If you have your project in GitHub, you can create issue templates or forms. +These allow you to ask for relevant information from contributors wanting to open a new issue to your repository. + +You can have a template for each type of issue. For example, it can be a bug report, +a request for a new feature, or a suggestion to improve your project's documentation. You could also ask for more +information. + +There are two ways to add templates into your project. You can set them up directly in the +settings of your repository, or you can create them with `YAML` format files. + +If you create the templates writing yourself the `YAML` format files, you can create them +locally (on your machine) and push them to your repository when ready. + +The templates files should be under the directory `.github/ISSUE_TEMPLATE` at the root of +your project. There should be one `YAML` file for each template, if you decide to have different types. +You also need a `config.yml` file if you want to customize the template selection. + +For a step by step guide, please visit the +[GitHub documentation](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository). + +## Examples of GitHub issue templates + +[Scikit-learn](https://github.com/scikit-learn/scikit-learn/tree/main/.github/ISSUE_TEMPLATE) + +[Polars](https://github.com/pola-rs/polars/tree/main/.github/ISSUE_TEMPLATE) + +[Narwhals](https://github.com/narwhals-dev/narwhals/tree/main/.github/ISSUE_TEMPLATE) + +[Tensorflow](https://github.com/tensorflow/tensorflow/tree/master/.github/ISSUE_TEMPLATE) \ No newline at end of file