Skip to content

Commit 7f1c046

Browse files
author
Ubuntu
committed
feat: add community funnels and contribution templates
1 parent 1281b90 commit 7f1c046

16 files changed

Lines changed: 423 additions & 3 deletions

‎.github/DISCUSSION_TEMPLATE/general.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
title: "[General]: "
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
Use this category for general feedback that does not fit setup help, ideas, or client setup showcases.
7+
- type: textarea
8+
id: topic
9+
attributes:
10+
label: Topic
11+
description: What do you want to discuss?
12+
placeholder: Share feedback about the repo structure, public distribution approach, or user onboarding flow.
13+
validations:
14+
required: true
15+

‎.github/DISCUSSION_TEMPLATE/ideas.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
title: "[Idea]: "
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
Use this category for growth ideas, new client guides, onboarding improvements, and distribution experiments.
7+
- type: input
8+
id: idea_summary
9+
attributes:
10+
label: Idea summary
11+
description: Keep it short and specific.
12+
placeholder: Add a Hiddify Next guide and dedicated landing page
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: user_value
17+
attributes:
18+
label: Why would users care?
19+
description: Explain the user problem or search demand this would solve.
20+
placeholder: Many users search for free Hiddify subscription import steps, but the repo does not currently capture that traffic.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: implementation
25+
attributes:
26+
label: Suggested implementation
27+
description: Optional page, docs, workflow, or conversion idea.
28+

‎.github/DISCUSSION_TEMPLATE/q-a.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
title: "[Setup Help]: "
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
Ask setup or troubleshooting questions here.
7+
8+
Good questions include:
9+
- which subscription format fits your client
10+
- why import fails in a specific app
11+
- why a node looks offline
12+
- type: input
13+
id: client
14+
attributes:
15+
label: Client or app
16+
description: Name the app you are using.
17+
placeholder: Clash Verge Rev, v2rayNG, sing-box, Shadowrocket
18+
validations:
19+
required: true
20+
- type: dropdown
21+
id: platform
22+
attributes:
23+
label: Platform
24+
options:
25+
- Windows
26+
- macOS
27+
- Linux
28+
- Android
29+
- iPhone or iPad
30+
- Other
31+
validations:
32+
required: true
33+
- type: dropdown
34+
id: format
35+
attributes:
36+
label: Subscription format
37+
options:
38+
- Clash YAML
39+
- sing-box JSON
40+
- V2Ray Base64
41+
- Not sure yet
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: question
46+
attributes:
47+
label: What do you need help with?
48+
description: Include the exact step where you are blocked.
49+
placeholder: I imported the Clash YAML into Clash Verge Rev, but the profile loads with zero nodes.
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: attempts
54+
attributes:
55+
label: What have you already tried?
56+
description: Share the status page, guide, or settings you checked.
57+

‎.github/DISCUSSION_TEMPLATE/show-and-tell.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
title: "[Client Setup]: "
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
Share working setups, screenshots, or import recipes that can help other users.
7+
- type: input
8+
id: client
9+
attributes:
10+
label: Client or app
11+
placeholder: v2rayNG, Clash Verge Rev, Shadowrocket
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: setup
16+
attributes:
17+
label: What worked?
18+
description: Share the exact import path, settings, or client behavior that helped.
19+
placeholder: Imported the latest release link, enabled auto update every 6 hours, and selected rule mode.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: notes
24+
attributes:
25+
label: Extra notes
26+
description: Optional screenshots, caveats, or tips for other users.
27+

‎.github/ISSUE_TEMPLATE/broken-feed.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Broken feed or stale status
2+
description: Report a subscription link, release asset, or status page problem.
3+
title: "[Broken Feed]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Use this form only for problems with the public feed itself.
11+
12+
Before submitting:
13+
- Check the live status dashboard and latest release first.
14+
- For client setup help, use Discussions > Q&A instead.
15+
- type: dropdown
16+
id: affected_artifact
17+
attributes:
18+
label: Affected artifact
19+
description: Which public entry is broken?
20+
options:
21+
- Clash subscription
22+
- sing-box subscription
23+
- V2Ray subscription
24+
- Status JSON
25+
- GitHub Pages site
26+
- Latest release asset
27+
validations:
28+
required: true
29+
- type: input
30+
id: url
31+
attributes:
32+
label: Exact URL
33+
description: Paste the failing raw link, Pages URL, or release download URL.
34+
placeholder: https://github.com/Au1rxx/free-vpn-subscriptions/releases/latest/download/clash.yaml
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: problem
39+
attributes:
40+
label: What happened?
41+
description: Include the client message, HTTP error, or mismatch you saw.
42+
placeholder: The latest release download returns 404, or the subscription imports but contains no nodes.
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: environment
47+
attributes:
48+
label: Client and environment
49+
description: Include app name, version, platform, and network context if relevant.
50+
placeholder: Clash Verge Rev 2.x on Windows 11, imported from the latest release link.
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: notes
55+
attributes:
56+
label: Extra notes
57+
description: Optional screenshots, timestamps, or reproduction details.
58+

‎.github/ISSUE_TEMPLATE/client-guide-request.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Client guide or compatibility request
2+
description: Request support content for a client, platform, or import flow.
3+
title: "[Client Request]: "
4+
labels:
5+
- documentation
6+
- enhancement
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Use this form when you want a new setup guide, a clearer import path, or client compatibility coverage.
12+
13+
If you only need help with your own setup, open a Discussion in Q&A instead.
14+
- type: input
15+
id: client
16+
attributes:
17+
label: Client name
18+
description: Name the app or client users search for.
19+
placeholder: Clash Meta for Android, NekoBox, Streisand, Hiddify Next
20+
validations:
21+
required: true
22+
- type: dropdown
23+
id: platform
24+
attributes:
25+
label: Platform
26+
options:
27+
- Windows
28+
- macOS
29+
- Linux
30+
- Android
31+
- iPhone or iPad
32+
- Multi-platform
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: use_case
37+
attributes:
38+
label: What should be added?
39+
description: Describe the guide, import method, or compatibility note you want.
40+
placeholder: Add a step-by-step guide for importing the V2Ray feed into NekoBox and explain which format users should choose.
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: search_terms
45+
attributes:
46+
label: Search terms people would use
47+
description: This helps prioritize SEO-aligned pages.
48+
placeholder: free nekobox subscription, how to import clash yaml on android, sing-box ios subscription
49+
validations:
50+
required: true
51+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Setup help and troubleshooting
4+
url: https://github.com/Au1rxx/free-vpn-subscriptions/discussions/new?category=q-a
5+
about: Use Discussions Q&A for client import help, app compatibility questions, and troubleshooting.
6+
- name: Client guide ideas
7+
url: https://github.com/Au1rxx/free-vpn-subscriptions/discussions/new?category=ideas
8+
about: Suggest new client guides, landing pages, and growth ideas here.
9+
- name: Live status dashboard
10+
url: https://au1rxx.github.io/free-vpn-subscriptions/status.html
11+
about: Check the current public node status before opening a bug report.
12+

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Summary
2+
3+
- Explain the user-facing change.
4+
- Link the related issue or discussion when possible.
5+
6+
## Checklist
7+
8+
- [ ] No secrets, credentials, node private material, or control-plane state are included
9+
- [ ] Public docs, Pages content, or output artifacts stay sanitized
10+
- [ ] Any user-facing link was checked locally before submitting
11+
- [ ] README or docs were updated if behavior or guidance changed
12+
13+
## Notes
14+
15+
Describe rollout risk, SEO impact, or follow-up work if relevant.
16+

‎CODE_OF_CONDUCT.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Code Of Conduct
2+
3+
This repository is a public help and distribution surface. Keep participation useful, direct, and respectful.
4+
5+
## Expected behavior
6+
7+
- Focus on client setup, public feed quality, and documentation quality.
8+
- Share reproducible details when reporting a problem.
9+
- Assume other users are here to solve a technical problem.
10+
- Keep criticism specific to the artifact, workflow, or guide being discussed.
11+
12+
## Unacceptable behavior
13+
14+
- Harassment, insults, or threats
15+
- Posting secrets, credentials, or private infrastructure details
16+
- Spam, link drops, or irrelevant promotion
17+
- Repeated low-information complaints without reproduction details
18+
19+
## Moderation
20+
21+
Maintainers may edit, close, lock, or remove content that breaks these rules or creates security risk for the project.
22+

‎CONTRIBUTING.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing
2+
3+
This repository is the public distribution layer for the VPN feed. It is optimized for three things:
4+
5+
- reliable subscription delivery
6+
- clear client onboarding
7+
- searchable public documentation
8+
9+
## Where to contribute
10+
11+
- Use `Discussions > Q&A` for setup help and troubleshooting.
12+
- Use `Discussions > Ideas` for new client guides, landing pages, and growth ideas.
13+
- Use `Issues` only for broken public artifacts, stale status, or site problems.
14+
- Use `Pull Requests` for docs, Pages, workflow, and public-output improvements.
15+
16+
## Scope rules
17+
18+
This repository should contain only public materials:
19+
20+
- public subscription artifacts in `output/`
21+
- sanitized status output
22+
- public docs and Pages content
23+
- GitHub workflow code used to publish public assets
24+
25+
Do not add:
26+
27+
- infrastructure state
28+
- cloud credentials
29+
- SSH keys
30+
- private node inventory
31+
- anything copied from the private control repository that is not meant for public distribution
32+
33+
## Good contribution targets
34+
35+
- new client setup guides that match real user search intent
36+
- clearer onboarding copy for Clash, sing-box, and V2Ray users
37+
- Pages improvements that reduce setup friction
38+
- broken-link fixes
39+
- FAQ improvements based on repeated user questions
40+
41+
## PR expectations
42+
43+
- Keep changes focused and easy to review.
44+
- Explain the user-facing reason for the change.
45+
- Verify that all new links resolve correctly.
46+
- Prefer plain, direct language over marketing fluff.
47+

0 commit comments

Comments
 (0)