diff --git a/README.md b/README.md index b735a4c54..59b05627b 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ [github actions page]: https://github.com/statisticsnorway/ssb-pypitemplate/actions?workflow=Tests [github page]: https://github.com/statisticsnorway/ssb-pypitemplate [license badge]: https://img.shields.io/github/license/statisticsnorway/ssb-pypitemplate -[license]: https://opensource.org/licenses/MIT +[license]: https://opensource.org/license/mit/ [pre-commit badge]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white [pre-commit project]: https://pre-commit.com/ [python version badge]: https://img.shields.io/pypi/pyversions/ssb-pypitemplate-instance diff --git a/docs/conf.py b/docs/conf.py index 2ff7a0616..20f72cb15 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,7 @@ "https://github.com/cjolowicz/cookiecutter-hypermodern-python/releases/tag/", "https://cookiecutter-hypermodern-python.readthedocs.io", "https://badgen.net/badge/status/alpha/d8624d", + "https://opensource.org/license/mit/", ] myst_enable_extensions = [ "colon_fence", diff --git a/docs/guide.md b/docs/guide.md index e49488902..5b7813b4d 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -2105,13 +2105,8 @@ It manages the following dependencies: Follow these steps to set up Read the Docs for your repository: 1. Sign up at [Read the Docs]. -2. Import your GitHub repository, - using the button _Import a Project_. -3. Install the GitHub [webhook][readthedocs webhooks], - using the button _Add integration_ - on the _Integrations_ tab - in the _Admin_ section of your project - on Read the Docs. +2. [Prepare][readthedocs prepare-github] your reposity on GitHUb +3. [Import the GitHub project][readthedocs import] to Read the Docs. Read the Docs automatically starts building your documentation, and will continue to do so when you push to the default branch or make a release. @@ -2714,7 +2709,8 @@ You can also read the articles on [this blog][hypermodern python blog]. [python website]: https://www.python.org/ [pyupgrade]: https://github.com/asottile/pyupgrade [read the docs]: https://readthedocs.org/ -[readthedocs webhooks]: https://docs.readthedocs.io/en/stable/webhooks.html +[readthedocs import]: https://docs.readthedocs.io/en/stable/tutorial/index.html#importing-the-project-to-read-the-docs +[readthedocs prepare-github]: https://docs.readthedocs.io/en/stable/tutorial/index.html#preparing-your-repository-on-github [relative imports]: https://docs.python.org/3/reference/import.html#package-relative-imports [release drafter]: https://github.com/release-drafter/release-drafter [release-drafter/release-drafter]: https://github.com/release-drafter/release-drafter diff --git a/{{cookiecutter.project_name}}/.github/ISSUE_TEMPLATE/bug_report.yml b/{{cookiecutter.project_name}}/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..becf1d940 --- /dev/null +++ b/{{cookiecutter.project_name}}/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,73 @@ +name: "\U0001F41E Bug Report" +description: Report a bug +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please fill out the sections below to help everyone identify and fix the bug + - type: textarea + id: description + attributes: + label: Describe the bug + placeholder: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Step 1... + 2. Step 2... + 3. Step 3... + 4. Step 4... + validations: + required: false + - type: textarea + id: expected + attributes: + label: Expected behaviour + placeholder: A clear and concise description of what you expected to happen. + validations: + required: false + - type: dropdown + id: platform + attributes: + label: Platforms and Environments + multiple: true + description: > + On which platforms does the bug occur? + The first four items are platforms in Statistics Norway. + You can select multiple platforms. + options: + - DaplaLab with vscode + - DaplaLab with Jupyter + - Jupyter on-prem + - Old Dapla with Jupyter + - Windows + - Linux + - macOS + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: What version of our software are you running? + placeholder: 1.0.0 + validations: + required: false + - type: textarea + id: logs + attributes: + label: Error messages or logs + description: Please copy and paste any relevant log output or error messages. + render: shell + validations: + required: false + - type: markdown + attributes: + value: | + Thanks for reporting this issue! We will get back to you as soon as possible. diff --git a/{{cookiecutter.project_name}}/.github/ISSUE_TEMPLATE/feature_request.yml b/{{cookiecutter.project_name}}/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..af9e9c0a4 --- /dev/null +++ b/{{cookiecutter.project_name}}/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,17 @@ +name: "\U0001F381 Feature Request" +description: Suggest a new feature or enhancment. +labels: ["enhancement"] +body: + - type: textarea + id: description + attributes: + label: Description + description: > + Describe the feature or enhancement and explain why it should be implemented. + Include a code example if applicable. + validations: + required: true + - type: markdown + attributes: + value: | + Thanks for reporting this issue! We will get back to you as soon as possible.