Add Contribution Guidelines page

Author: chrimaho

docs/overrides/hooks/shortcodes.py

@@ -77,7 +77,7 @@ def on_page_markdown(markdown: str, *, page: Page, config: MkDocsConfig, files:
     # are referenced in the main page, but their content is not included in the
     # main page. This is done using the Snippets Notation: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#snippets-notation
     # In this case, we will read the content of the source file and return it.
-    short_referenced_pages: list[str] = ["overview", "changelog"]
+    short_referenced_pages: list[str] = ["overview", "changelog", "contributing"]
     if page.file.name in short_referenced_pages:
         pattern = r'-*8<-*\s*"([^"]+)"'
         match = re.search(pattern, markdown)

docs/usage/contributing.md

@@ -0,0 +1 @@
+--8<-- "CONTRIBUTING.md"

mkdocs.yaml

@@ -47,6 +47,7 @@ nav:
   - Home: index.md
   - Usage:
       - Overview: usage/overview.md
+      - Contributing: usage/contributing.md
       - Change Log: usage/changelog.md
   - Modules:
       - code/index.md

src/utils/changelog.py

@@ -119,7 +119,7 @@ def add_release_info(release: GitRelease, repo: Repository) -> str:
         f"{TAB}## **{release.title}**{BLANK_LINE}"
         f"{TAB}<!-- md:tag {release.tag_name} -->{LINE_BREAK}{NEW_LINE}"
         f"{TAB}<!-- md:date {release.created_at.date()} -->{LINE_BREAK}{NEW_LINE}"
-        f"{TAB}<!-- md:link [{repo.full_name}/releases/tag/{release.tag_name}]({release.html_url}) -->{BLANK_LINE}"
+        f"{TAB}<!-- md:link [{repo.full_name}/releases/{release.tag_name}]({release.html_url}) -->{BLANK_LINE}"
     )