Skip to content

Commit 38fa59c

Browse files
Mindstormman06Mindstormman06
authored
Merge pull request #66 from Clonephaze/main
Add community standards, templates, and Dependabot configuration
2 parents cd14fd2 + 18e2145 commit 38fa59c

8 files changed

Lines changed: 208 additions & 0 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# CODEOWNERS
2+
#
3+
# This file defines who is automatically requested as a reviewer when a pull
4+
# request modifies files matching a given pattern. GitHub checks this file from
5+
# bottom to top — the last matching rule wins.
6+
#
7+
# Format:
8+
# <glob pattern> <@username or @org/team> [<additional owners>...]
9+
#
10+
# Examples:
11+
# * @someone — matches every file (catch-all)
12+
# *.ts @someone — all TypeScript files
13+
# src/ @someone — everything under src/
14+
# src/bridge.ts @someone @other — one specific file, multiple owners
15+
# docs/ @docs-person — only doc changes go to this person
16+
#
17+
# A GitHub team can be used instead of individual usernames:
18+
# * @TKVSC-Team/maintainers
19+
#
20+
# The wildcard * below assigns all files to the maintainers team, meaning
21+
# every PR will request a review from that team by default. This team will need to be set up in
22+
# the repository settings with the appropriate members and permissions for this to work effectively.
23+
24+
* @TKVSC-Team/maintainers

‎.github/CONTRIBUTING.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to TKVSC
2+
3+
Thanks for your interest in contributing! Here's what you need to know.
4+
5+
## Getting started
6+
7+
1. Fork the repository and clone your fork
8+
2. Run `npm install` to install Node dependencies
9+
3. Run the setup script for Python: `scripts/setup.ps1` (Windows) or `scripts/setup.sh` (Linux/macOS)
10+
4. Open the project in VS Code and press `F5` to launch the extension in a dev host window
11+
12+
## Before submitting a PR
13+
14+
- Make sure the extension builds: `npm run build`
15+
- Run `npm run fix` to lint and format both TypeScript and Python
16+
- Keep changes focused — one concern per PR
17+
- Reference any related issue in your PR description (e.g. `Closes #123`)
18+
- Don't include unrelated formatting or whitespace changes
19+
20+
## Code style
21+
22+
- TypeScript source lives in `src/`, Python scripts in `python/`
23+
- Follow the existing patterns in the file you're editing
24+
- Run `npm run fix` before submitting — this runs both TypeScript and Python linting and formatting in one step
25+
26+
## Questions?
27+
28+
Join the [TKVSC Discord](https://discord.gg/vwPnX2uB8s) if you want to discuss a contribution before starting.

‎.github/DISCUSSION_TEMPLATE/general.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: General
2+
description: General discussion about TKVSC
3+
labels: ["discussion"]
4+
body:
5+
- type: textarea
6+
id: body
7+
attributes:
8+
label: Discussion
9+
description: What would you like to discuss?
10+
validations:
11+
required: true

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Q&A
2+
description: Ask a question about TKVSC
3+
labels: ["question"]
4+
body:
5+
- type: textarea
6+
id: question
7+
attributes:
8+
label: Your question
9+
description: What do you want to know?
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: context
15+
attributes:
16+
label: Context
17+
description: Any relevant context, screenshots, or file types involved.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
11
blank_issues_enabled: false
2+
contact_links:
3+
- name: TKVSC Discord
4+
url: https://discord.gg/vwPnX2uB8s
5+
about: Ask questions or get help from the community on Discord
6+
- name: Documentation
7+
url: https://github.com/TKVSC-Team/totk-vscode/tree/main/docs
8+
about: Browse the docs for setup guides, commands, and settings
9+
- name: GameBanana Page
10+
url: https://gamebanana.com/tools/22893
11+
about: Download releases and read the project description on GameBanana

‎.github/SECURITY.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Only the latest release of TKVSC is actively supported with security fixes.
6+
7+
## Reporting a Vulnerability
8+
9+
**Please do not report security vulnerabilities publicly via GitHub Issues.**
10+
11+
To report a vulnerability, please use one of the following private channels:
12+
13+
- **GitHub private security advisory**: [Report a vulnerability](../../security/advisories/new)
14+
- **Discord**: Reach us directly in the [TKVSC Discord](https://discord.gg/vwPnX2uB8s) via DM to a maintainer
15+
16+
We will acknowledge your report within a few days and aim to release a fix as soon as reasonably possible. You will be credited in the release notes unless you prefer to remain anonymous.

‎.github/dependabot.yml‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# dependabot.yml
2+
#
3+
# Dependabot automatically opens pull requests when dependencies have updates
4+
# available. This keeps the project secure and up to date without manual checks.
5+
#
6+
# Each "updates" block targets one package ecosystem. This repository has two:
7+
# - npm : Node.js dependencies defined in package.json
8+
# - pip : Python dependencies defined in pyproject.toml / requirements files
9+
#
10+
# Key options:
11+
#
12+
# schedule.interval — "daily" | "weekly" | "monthly"
13+
# schedule.day/time — when within the interval to run (Monday 6am here)
14+
# schedule.timezone — IANA timezone for the above time
15+
#
16+
# open-pull-requests-limit — max number of open dep-bump PRs at once (default 5)
17+
# set to 0 to pause updates for that ecosystem
18+
#
19+
# labels — GitHub labels automatically applied to the opened PRs
20+
#
21+
# commit-message.prefix — prepended to the commit message (e.g. "chore: bump X")
22+
# commit-message.include — "scope" adds the package name in parentheses
23+
#
24+
# groups — bundle multiple related packages into a single PR instead of one PR per package.
25+
# Without groups, a project with 20 deps could open 20 PRs.
26+
#
27+
# ignore — blacklist or limit updates for specific packages
28+
#
29+
# allow — whitelist only specific packages
30+
31+
version: 2
32+
updates:
33+
# ── npm (Node.js / TypeScript) ─────────────────────────────────────────────
34+
# Watches package.json at the repo root and opens PRs for outdated packages.
35+
# Related packages are grouped so one PR handles e.g. all eslint updates.
36+
- package-ecosystem: "npm"
37+
directory: "/"
38+
schedule:
39+
interval: "weekly"
40+
day: "monday"
41+
time: "06:00"
42+
timezone: "America/Chicago"
43+
open-pull-requests-limit: 5
44+
labels:
45+
- "dependencies"
46+
- "automated"
47+
commit-message:
48+
prefix: "chore"
49+
include: "scope"
50+
groups:
51+
typescript:
52+
patterns:
53+
- "typescript"
54+
- "@types/*"
55+
esbuild:
56+
patterns:
57+
- "esbuild"
58+
- "esbuild-*"
59+
eslint:
60+
patterns:
61+
- "eslint"
62+
- "@eslint/*"
63+
- "eslint-*"
64+
vscode:
65+
patterns:
66+
- "@vscode/*"
67+
- "@types/vscode"
68+
69+
# ── pip (Python) ───────────────────────────────────────────────────────────
70+
# Watches pyproject.toml / requirements files at the repo root.
71+
- package-ecosystem: "pip"
72+
directory: "/"
73+
schedule:
74+
interval: "weekly"
75+
day: "monday"
76+
time: "06:00"
77+
timezone: "America/Chicago"
78+
open-pull-requests-limit: 5
79+
labels:
80+
- "dependencies"
81+
- "automated"
82+
commit-message:
83+
prefix: "chore"
84+
include: "scope"

‎.github/pull_request_template.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Summary
2+
<!-- Briefly describe what this PR does and why. -->
3+
4+
## Related issues
5+
<!-- Link any related issues: "Closes #123" or "Related to #456" -->
6+
7+
## Type of change
8+
- [ ] Bug fix
9+
- [ ] New feature
10+
- [ ] Refactor / cleanup
11+
- [ ] Documentation
12+
- [ ] Dependency update
13+
- [ ] Other (describe below)
14+
15+
## Checklist
16+
- [ ] Code builds without errors (`npm run build`)
17+
- [ ] Changes are tested locally
18+
- [ ] No unrelated files changed

0 commit comments

Comments
 (0)