Small fixes to the template

abelsiqueira · Jun 7, 2024 · 6ce66ce · 6ce66ce
1 parent 4cb950f
commit 6ce66ce
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 13 deletions.
diff --git a/...late/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/10-bug-report.yml.jinja b/...late/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/10-bug-report.yml.jinja
@@ -8,11 +8,11 @@ body:
       value: |
         Thanks for taking the time to fill out this bug report!
 
-        Please, before submitting make sure that:
+        Please, before submitting, make sure that:
 
         - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question
         - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/)
-        - You follow the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md)
+        - You are following the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md)
 
         The form below should help you in filling out this issue.
   - type: textarea

diff --git a/....github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/20-feature-request.yml.jinja b/....github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/20-feature-request.yml.jinja
@@ -6,11 +6,11 @@ body:
       value: |
         Thanks for taking the time to fill out this bug report!
 
-        Please, before submitting make sure that:
+        Please, before submitting, make sure that:
 
         - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question
         - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/)
-        - You follow the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md)
+        - You are following the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md)
 
         The form below should help you in filling out this issue.
   - type: textarea

diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/30-usage.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/30-usage.yml.jinja
@@ -7,12 +7,12 @@ body:
       value: |
         Thanks for taking the time to fill out this bug report!
 
-        Please, before submitting make sure that:
+        Please, before submitting, make sure that:
 
         - You have checked the [documentation](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl) and haven't found enough information
         - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question
         - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/)
-        - You follow the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md)
+        - You are following the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md)
 
         The form below should help you in filling out this issue.
   - type: textarea

diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/99-general.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/99-general.yml.jinja
@@ -6,11 +6,11 @@ body:
       value: |
         Thanks for taking the time to fill out this bug report!
 
-        Please, before submitting make sure that:
+        Please, before submitting, make sure that:
 
         - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question
         - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/)
-        - You follow the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md)
+        - You are following the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md)
 
         The form below should help you in filling out this issue.
   - type: textarea

diff --git a/template/README.md.jinja b/template/README.md.jinja
@@ -1,6 +1,5 @@
 # {{ PackageName }}
 
-<!-- This check was disabled because these links don't exist until you push, create documentation, and create your first release -->
 [![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/stable)
 [![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/dev)
 [![Build Status](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/workflows/Test/badge.svg)](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/actions)
@@ -11,7 +10,7 @@
 [![Coverage](https://codecov.io/gh/{{ PackageOwner }}/{{ PackageName }}.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/{{ PackageOwner }}/{{ PackageName }}.jl)
 [![DOI](https://zenodo.org/badge/DOI/FIXME)](https://doi.org/FIXME)
 {% if AddCodeOfConduct %}[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md){% endif %}
-{% if AddAllcontributors %}[![All Contributors](https://img.shields.io/github/all-contributors/{{ PackageOwner }}/{{ PackageName }}.jl?labelColor=5e1ec7&color=c0ffee&style=flat-square))](.all-contributorsrc){% endif %}
+{% if AddAllcontributors %}[![All Contributors](https://img.shields.io/github/all-contributors/{{ PackageOwner }}/{{ PackageName }}.jl?labelColor=5e1ec7&color=c0ffee&style=flat-square))](#contributors){% endif %}
 
 ## How to Cite
 

diff --git a/template/docs/src/90-contributing.md.jinja b/template/docs/src/90-contributing.md.jinja
@@ -1,10 +1,10 @@
-# Contributing guidelines
+# [Contributing guidelines](@id contributing)
 
 First of all, thanks for the interest!
 
 We welcome all kinds of contribution, including, but not limited to code, documentation, examples, configuration, issue creating, etc.
 
-Be polite and respectful.
+Be polite and respectful, and follow the code of conduct.
 
 ## Bug reports and discussions
 

diff --git a/template/docs/src/90-reference.md.jinja b/template/docs/src/90-reference.md.jinja
@@ -1,4 +1,4 @@
-# Reference
+# [Reference](@id reference)
 
 ## Contents
 

diff --git a/template/docs/src/index.md.jinja b/template/docs/src/index.md.jinja
@@ -8,6 +8,7 @@ Documentation for [{{ PackageName }}](https://github.com/{{ PackageOwner }}/{{ P
 
 {% if AddAllcontributors %}## Contributors
 
+```@raw
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
@@ -16,4 +17,5 @@ Documentation for [{{ PackageName }}](https://github.com/{{ PackageOwner }}/{{ P
 <!-- prettier-ignore-end -->
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
+```
 {% endif %}