From e205f393fbb44ca7c6cf4d764fb1f455519f8a09 Mon Sep 17 00:00:00 2001
From: Innei <tukon479@gmail.com>
Date: Fri, 1 Nov 2024 15:34:09 +0800
Subject: [PATCH] chore: update template

Signed-off-by: Innei <tukon479@gmail.com>
---
 .github/PULL_REQUEST_TEMPLATE.md | 17 +++++++-
 CONTRIBUTE.md                    | 71 ++++++++++++++++++++++++++++++++
 changelog/next.md                |  6 +++
 changelog/next.template.md       |  6 +++
 4 files changed, 99 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTE.md

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index fce33762e..076ed77a1 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -4,7 +4,7 @@ Thank you for contributing!
 
 Before submitting the PR, please make sure you do the following:
 
-- Read the [Contributing Guide](https://github.com/antfu/contribute).
+- Read the [Contributing Guide](/contribute).
 - Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
 - Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`).
 - Ideally, include relevant tests that fail without this PR but pass with it.
@@ -15,8 +15,23 @@ Before submitting the PR, please make sure you do the following:
 
 <!-- Please insert your description here and provide especially info about the "what" this PR is solving -->
 
+### PR Type
+
+<!-- Please check the type of PR: -->
+
+- [ ] Feature
+- [ ] Bugfix
+- [ ] Hotfix
+- [ ] Other (please describe):
+
 ### Linked Issues
 
 ### Additional context
 
 <!-- e.g. is there anything you'd like reviewers to focus on? -->
+
+### Changelog
+
+<!-- Please ensure the changelog/next.md is updated if this is a feature or hotfix: -->
+
+- [ ] I have updated the changelog/next.md with my changes.
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
new file mode 100644
index 000000000..8b5af1149
--- /dev/null
+++ b/CONTRIBUTE.md
@@ -0,0 +1,71 @@
+# Contributing to Follow
+
+Thank you for considering contributing to Follow! We welcome contributions from the community to help improve and expand the project.
+
+## Getting Started
+
+Before you start contributing, please ensure you have enabled [Corepack](https://nodejs.org/api/corepack.html). Corepack ensures you are using the correct version of the package manager specified in the `package.json`.
+
+```sh
+corepack enable
+```
+
+### Installing Dependencies
+
+To install the necessary dependencies, run:
+
+```sh
+pnpm install
+```
+
+## Development Setup
+
+### Develop in the Browser
+
+For a more convenient development experience, we recommend developing in the browser:
+
+```sh
+pnpm run dev:web
+```
+
+This will open the browser at `https://app.follow.is/__debug_proxy`, allowing you to access the online API environment for development and debugging.
+
+### Develop in Electron
+
+If you prefer to develop in Electron, follow these steps:
+
+1. Copy the example environment variables file:
+
+   ```sh
+   cp .env.example .env
+   ```
+
+2. Set `VITE_API_URL` to `https://api.follow.is` in your `.env` file.
+
+3. Run the development server:
+
+   ```sh
+   pnpm run dev
+   ```
+
+> **Tip:** If you encounter login issues, copy the `authjs.session-token` from your browser's cookies into the app.
+
+## Contribution Guidelines
+
+- Ensure your code follows the project's coding standards and conventions.
+- Write clear, concise commit messages.
+- Include relevant tests for your changes.
+- Update documentation as necessary.
+
+## Community
+
+Join our community to discuss ideas, ask questions, and share your contributions:
+
+- [Discord](https://discord.gg/followapp)
+- [Twitter](https://x.com/intent/follow?screen_name=follow_app_)
+
+We look forward to your contributions!
+
+## License
+
+By contributing to Follow, you agree that your contributions will be licensed under the GNU General Public License version 3, with the special exceptions noted in the `README.md`.
diff --git a/changelog/next.md b/changelog/next.md
index 587f19d1e..17888d80b 100644
--- a/changelog/next.md
+++ b/changelog/next.md
@@ -1 +1,7 @@
 # What's new in vNEXT_VERSION
+
+## New Features
+
+## Improvements
+
+## Bug Fixes
diff --git a/changelog/next.template.md b/changelog/next.template.md
index 587f19d1e..17888d80b 100644
--- a/changelog/next.template.md
+++ b/changelog/next.template.md
@@ -1 +1,7 @@
 # What's new in vNEXT_VERSION
+
+## New Features
+
+## Improvements
+
+## Bug Fixes