Skip to content

Commit 570fbcd

Browse files
committed
docs: add repository governance files
1 parent eabd1c1 commit 570fbcd

4 files changed

Lines changed: 60 additions & 0 deletions

File tree

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Pigbibi

.github/dependabot.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "npm"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
open-pull-requests-limit: 5
8+
- package-ecosystem: "github-actions"
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"
12+
open-pull-requests-limit: 5

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
Thanks for contributing to `SchwabTokenAutoRefresher`.
4+
5+
## Ground Rules
6+
7+
- Prefer small, low-risk pull requests.
8+
- Keep refactors separate from behavior changes.
9+
- Add or update tests when changing runtime behavior.
10+
- Do not use deployment or scheduled workflows as a substitute for local verification.
11+
12+
## Branching and Pull Requests
13+
14+
- Create a topic branch for each change.
15+
- Open a pull request with a short summary and a concrete test plan.
16+
- Wait for CI to pass before merging.
17+
18+
## Local Verification
19+
20+
Run the main verification command before opening a pull request:
21+
22+
```bash
23+
npm install && node --check main.js && bash tests/test_workflow_config_sources.sh
24+
```

SECURITY.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Security Policy
2+
3+
Thanks for helping keep `SchwabTokenAutoRefresher` safe.
4+
5+
This repository is part of a automation utility. Please do **not** open a public issue for vulnerabilities involving credentials, broker access, cloud resources, order execution, or secret material.
6+
7+
## Reporting a Vulnerability
8+
9+
- Contact the maintainer directly at GitHub: `@Pigbibi`.
10+
- If private vulnerability reporting is enabled for this repository, prefer that channel.
11+
- Include the repository name, affected commit or branch, environment details, and exact reproduction steps.
12+
13+
## Secret and Credential Exposure
14+
15+
If you suspect tokens, passwords, API keys, service-account keys, or broker credentials were exposed:
16+
17+
1. Rotate the exposed secrets immediately.
18+
2. Pause scheduled jobs or deployments if the exposure can affect automation or trading behavior.
19+
3. Share only the minimum evidence needed to reproduce the issue.
20+
21+
## Scope Notes
22+
23+
Security fixes should stay minimal and focused. Please avoid bundling unrelated refactors with a security report or patch.

0 commit comments

Comments
 (0)