From 05aa142ba7e9e017b7c8fe8eeb27f313667f0d48 Mon Sep 17 00:00:00 2001 From: Aline Abler Date: Tue, 21 Nov 2023 13:32:06 +0100 Subject: [PATCH 1/2] Fix grammar in Readme and PR template --- {{ cookiecutter.slug }}/.github/PULL_REQUEST_TEMPLATE.md | 4 ++-- {{ cookiecutter.slug }}/README.md | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/{{ cookiecutter.slug }}/.github/PULL_REQUEST_TEMPLATE.md b/{{ cookiecutter.slug }}/.github/PULL_REQUEST_TEMPLATE.md index e2119f0..b8eaf6a 100644 --- a/{{ cookiecutter.slug }}/.github/PULL_REQUEST_TEMPLATE.md +++ b/{{ cookiecutter.slug }}/.github/PULL_REQUEST_TEMPLATE.md @@ -3,7 +3,7 @@ ## Checklist -- [ ] The PR has a meaningful title. It will be used to auto generate the +- [ ] The PR has a meaningful title. It will be used to auto-generate the changelog. The PR has a meaningful description that sums up the change. It will be linked in the changelog. @@ -21,6 +21,6 @@ review the checklist. Contributors guide: ./CONTRIBUTING.md Remove items that do not apply. For completed items, change [ ] to [x]. -These things are not required to open a PR and can be done afterwards, +These things are not required to open a PR and can be done afterwards while the PR is open. --> diff --git a/{{ cookiecutter.slug }}/README.md b/{{ cookiecutter.slug }}/README.md index d1a6718..33cc07b 100644 --- a/{{ cookiecutter.slug }}/README.md +++ b/{{ cookiecutter.slug }}/README.md @@ -3,15 +3,15 @@ This is a [Commodore][commodore] Component for {{ cookiecutter.name }}. This repository is part of Project Syn. -For documentation on Project Syn and this component, see https://syn.tools. +For documentation on Project Syn and this component, see [syn.tools](https://syn.tools). ## Documentation The rendered documentation for this component is available on the [Commodore Components Hub](https://hub.syn.tools/{{ cookiecutter.slug }}). Documentation for this component is written using [Asciidoc][asciidoc] and [Antora][antora]. -It is located in the [docs/](docs) folder. -The [Divio documentation structure](https://documentation.divio.com/) is used to organize its content. +It can be found in the [`docs`](docs) folder. +The [Divio documentation structure](https://documentation.divio.com/) organizes its content. Run the `make docs-serve` command in the root of the project, and then browse to http://localhost:2020 to see a preview of the current state of the documentation. @@ -20,7 +20,7 @@ After writing the documentation, please use the `make docs-vale` command and cor ## Contributing and license This library is licensed under [BSD-3-Clause](LICENSE). -For information about how to contribute see [CONTRIBUTING](CONTRIBUTING.md). +For information about how to contribute, see [CONTRIBUTING](CONTRIBUTING.md). [commodore]: https://syn.tools/commodore/ [asciidoc]: https://asciidoctor.org/ From 99993b0c53b9f5b488ae19c972856aecebae44e1 Mon Sep 17 00:00:00 2001 From: Aline Abler Date: Tue, 21 Nov 2023 14:36:59 +0100 Subject: [PATCH 2/2] Update {{ cookiecutter.slug }}/README.md Co-authored-by: Simon Gerber --- {{ cookiecutter.slug }}/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{ cookiecutter.slug }}/README.md b/{{ cookiecutter.slug }}/README.md index 33cc07b..6f4aa40 100644 --- a/{{ cookiecutter.slug }}/README.md +++ b/{{ cookiecutter.slug }}/README.md @@ -11,7 +11,7 @@ The rendered documentation for this component is available on the [Commodore Com Documentation for this component is written using [Asciidoc][asciidoc] and [Antora][antora]. It can be found in the [`docs`](docs) folder. -The [Divio documentation structure](https://documentation.divio.com/) organizes its content. +We use the [Divio documentation structure](https://documentation.divio.com/) to organize our documentation. Run the `make docs-serve` command in the root of the project, and then browse to http://localhost:2020 to see a preview of the current state of the documentation.