docs: add changelog and contributing.md

Author: Undertone0809

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "p3g"
-version = "1.6.0"
+version = "1.7.0"
 description = "Python Packages Project Generator"
 readme = "README.md"
 authors = ["Zeeland <zeeland4work@gmail.com>"]

{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/.vitepress/config.mts

@@ -11,7 +11,7 @@ export default withPwa(
       logo: "/logo.png",
       nav: [
         { text: "Home", link: "/" },
-        { text: "Guide", link: "/guide/" },
+        { text: "Guide", link: "/guide/introduction" },
         { text: "API", link: "/api/" },
         {
           text: "GitHub",
@@ -22,8 +22,8 @@ export default withPwa(
         {
           text: "Introduction",
           items: [
-            { text: "Getting Started", link: "/guide/" },
-            { text: "Installation", link: "/guide/installation" },
+            { text: "Introduction", link: "/guide/introduction" },
+            { text: "Quick Start", link: "/guide/quick-start" },
           ],
         },
         {
@@ -33,6 +33,13 @@ export default withPwa(
             { text: "Examples", link: "/api/examples" },
           ],
         },
+        {
+          text: "Other",
+          items: [
+            { text: "Changelog", link: "/other/changelog" },
+            { text: "Contributing", link: "/other/contributing" },
+          ],
+        },
       ],
       socialLinks: [
         {

…replace('-', '_') }}/docs/guide/index.md …('-', '_') }}/docs/guide/introduction.md{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/guide/index.md renamed to {{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/guide/introduction.md {{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/guide/index.md renamed to {{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/guide/introduction.md

@@ -0,0 +1,3 @@
+# Changelog
+
+You can see the changelog in the [releases page](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/releases).

…('-', '_') }}/docs/guide/installation.md …e('-', '_') }}/docs/guide/quick-start.md{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/guide/installation.md renamed to {{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/guide/quick-start.md {{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/guide/installation.md renamed to {{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/docs/guide/quick-start.md

@@ -0,0 +1,74 @@
+# Contributing to {{ cookiecutter.project_name }}
+
+We welcome contributions to {{ cookiecutter.project_name }}! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+1. Click [here](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/fork) to fork the repository on GitHub.
+2. Clone your fork locally:
+
+   ```bash
+   git clone https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}.git
+   cd {{ cookiecutter.project_name }}
+   ```
+
+3. Create a virtual environment and install dependencies:
+
+   ```bash
+   conda create -n {{ cookiecutter.project_name }} python==3.10
+   conda activate {{ cookiecutter.project_name }}
+
+   pip install poetry
+   poetry install
+   ```
+
+## Development Workflow
+
+Here are the steps to contribute to the project and make a pull request on GitHub:
+
+1. Create a new branch for your feature or bugfix:
+
+   ```bash
+   git checkout -b feature-or-fix-name
+   ```
+
+2. Make your changes and commit them after testing:
+
+   ```bash
+   make test
+   git commit -m "Your detailed commit message"
+   ```
+
+3. Push your changes to your fork:
+
+   ```bash
+   git push origin feature-or-fix-name
+   ```
+
+4. Submit a pull request through the GitHub website.
+
+## Coding Standards
+
+- We use `ruff` for code formatting, run `make format` and `make lint before committing.
+- Use pytest for testing, run `make test` before committing.
+- Write clear, commented code.
+- Include unit tests and related documentation for new features.
+
+## Run Tests
+
+Run the test suite using:
+
+```bash
+make test
+```
+{% if cookiecutter.create_docs == 'yes' %}
+
+## Run Documentation
+
+Run the documentation server locally, you can edit them in `./docs`
+
+```bash
+make install-docs
+make start-docs
+```
+{% endif %}