Skip to content

Commit c7fa1f2

Browse files
authored
Merge branch 'main' into split/pr75-sync-foundation
2 parents 171d5c5 + 4b4ef5f commit c7fa1f2

20 files changed

+456
-1335
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
blank_issues_enabled: false
22
contact_links:
3+
- name: Getting Started and Troubleshooting
4+
url: https://github.com/ndycode/oc-chatgpt-multi-auth/tree/main/docs
5+
about: Read the setup, configuration, FAQ, and troubleshooting guides before opening a new issue
36
- name: OpenAI Support
47
url: https://help.openai.com/
58
about: For ChatGPT account or subscription issues, contact OpenAI directly
69
- name: OpenAI Terms of Service
710
url: https://openai.com/policies/terms-of-use/
811
about: Review OpenAI's Terms of Service for compliance questions
9-
- name: Discussions
10-
url: https://github.com/numman-ali/opencode-openai-codex-auth/discussions
11-
about: Ask questions or discuss the plugin with the community

.github/pull_request_template.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Maintainer note: the anti-slop canary token is configured in .github/workflows/pr-quality.yml under blocked-terms. Keep the template and workflow in sync, and do not put the raw token in contributor-facing files. -->
2+
3+
## Summary
4+
5+
- What changed?
6+
- Why is this needed?
7+
8+
## Testing
9+
10+
- [ ] `npm run lint`
11+
- [ ] `npm run build`
12+
- [ ] `npm test`
13+
- [ ] Not applicable
14+
15+
## Compliance Confirmation
16+
17+
- [ ] This change stays within the repository scope and OpenAI Terms of Service expectations.
18+
- [ ] This change uses official authentication flows only and does not add bypass, scraping, or credential-sharing behavior.
19+
- [ ] I updated tests and documentation when the change affected users, maintainers, or repository behavior.
20+
21+
## Notes
22+
23+
- Linked issue:
24+
- Follow-up work or rollout notes:

.github/workflows/pr-quality.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: PR Quality
2+
3+
permissions:
4+
contents: read
5+
issues: read
6+
pull-requests: write
7+
8+
on:
9+
# Use pull_request_target so the action can comment on fork PRs without
10+
# checking out or executing contributor code from the PR branch.
11+
pull_request_target:
12+
types:
13+
- opened
14+
- reopened
15+
- synchronize
16+
- edited
17+
- ready_for_review
18+
- labeled
19+
- unlabeled
20+
21+
jobs:
22+
anti-slop:
23+
runs-on: ubuntu-latest
24+
concurrency:
25+
group: pr-quality-${{ github.event.pull_request.number }}
26+
cancel-in-progress: true
27+
steps:
28+
- name: Screen pull request quality
29+
uses: peakoss/anti-slop@85daca1880e9e1af197fc06ea03349daf08f4202 # v0.2.1
30+
with:
31+
max-failures: 1
32+
require-pr-template: true
33+
# Keep this public canary aligned with the hidden template note below.
34+
# It is best-effort only, so rotate it if it becomes noisy or stale.
35+
blocked-terms: |
36+
OBSIDIAN1455
37+
# anti-slop documents exact file and folder entries here, so this
38+
# list guards the canonical metadata files and PR screening surfaces.
39+
blocked-paths: |
40+
SECURITY.md
41+
LICENSE
42+
CODE_OF_CONDUCT.md
43+
CODEOWNERS
44+
.github/workflows/pr-quality.yml
45+
.github/pull_request_template.md
46+
exempt-label: exempt
47+
exempt-draft-prs: true
48+
close-pr: false
49+
lock-pr: false
50+
failure-pr-message: |
51+
Thanks for the contribution. This repository automatically screens pull requests for incomplete, low-signal, or non-compliant submissions before maintainers spend review time.
52+
53+
Please review CONTRIBUTING.md, complete the PR template with concrete summary and testing details, and update the PR if anything important is missing.
54+
55+
If this looks like a false positive, a maintainer can override the workflow with the `exempt` label after review.

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ all notable changes to this project. dates are ISO format (YYYY-MM-DD).
1717

1818
- **account storage schema**: V3 account metadata now includes optional `accountTags` and `accountNote`.
1919
- **docs refresh for operational flows**: README + docs portal/development guides updated to reflect beginner commands, safe mode, interactive picker behavior, and backup/import safeguards.
20+
- **repository presentation refresh**: rewrote the README as a landing page, added a public FAQ and code of conduct, refreshed package metadata, and removed stale CI/test claims from public docs surfaces.
2021
- **test matrix expansion**: coverage now includes beginner UI helpers, safe-fix diagnostics edge cases, tag/note command behavior, and timestamped backup/import preview utilities.
2122

2223
### fixed

CODE_OF_CONDUCT.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Code of Conduct
2+
3+
## Our Standard
4+
5+
This project expects respectful, practical, and security-conscious collaboration.
6+
7+
Examples of behavior that supports a productive environment:
8+
9+
- being respectful in discussion, code review, and issue reports
10+
- focusing on reproducible problems and concrete improvements
11+
- being clear about limitations, risks, and compliance boundaries
12+
- helping other contributors use the project responsibly
13+
14+
Examples of unacceptable behavior:
15+
16+
- harassment, insults, or personal attacks
17+
- requests for help violating platform terms or bypassing safeguards
18+
- sharing credentials, tokens, or private account data
19+
- encouraging commercial misuse or multi-user abuse of personal subscriptions
20+
21+
## Scope
22+
23+
This code of conduct applies to issues, pull requests, discussions around the repository, and other project spaces where contributors represent the project.
24+
25+
## Reporting
26+
27+
For conduct concerns, contact the maintainer through GitHub or the security contact path in [SECURITY.md](SECURITY.md) when privacy is important.
28+
29+
## Enforcement
30+
31+
Project maintainers may remove, edit, or reject contributions and interactions that do not align with this code of conduct.

CONTRIBUTING.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Contributing Guidelines
1+
# Contributing
22

3-
Thank you for your interest in contributing to oc-chatgpt-multi-auth!
3+
Thank you for contributing to `oc-chatgpt-multi-auth`.
44

5-
Before submitting contributions, please review these guidelines to ensure all changes maintain compliance with OpenAI's Terms of Service and the project's goals.
5+
This project accepts improvements that make the OpenCode plugin clearer, safer, easier to maintain, and more useful for personal development workflows.
66

77
## Compliance Requirements
88

@@ -33,13 +33,28 @@ All contributions MUST:
3333
- Credential sharing mechanisms
3434
- Features designed to violate OpenAI's terms
3535

36+
## Scope and Compliance
37+
38+
Contributions should stay within the project's intended scope:
39+
40+
- personal development workflows in OpenCode
41+
- official OAuth authentication flows
42+
- reliable GPT-5/Codex model support
43+
- documentation, debugging, testing, and maintainability improvements
44+
45+
The project does not accept work aimed at:
46+
47+
- commercial resale or shared multi-user access
48+
- bypassing safeguards, scraping sessions, or avoiding platform controls
49+
- misleading documentation or exaggerated capability claims
50+
3651
## Code Standards
3752

3853
- **TypeScript:** All code must be TypeScript with strict type checking
39-
- **Testing:** Include tests for new functionality (we maintain 200+ unit tests)
54+
- **Testing:** Include or update tests for behavioral changes
4055
- **Documentation:** Update README.md for user-facing changes
41-
- **Modular design:** Keep functions focused and under 40 lines
42-
- **No external dependencies:** Minimize dependencies (currently only @openauthjs/openauth)
56+
- **Modular design:** Keep functions focused and easy to review
57+
- **Dependencies:** Add new dependencies only when the benefit is clear
4358

4459
## Pull Request Process
4560

@@ -48,8 +63,13 @@ All contributions MUST:
4863
3. **Include tests** for new functionality
4964
4. **Update documentation** (README.md, config examples, etc.)
5065
5. **Ensure compliance** with guidelines above
51-
6. **Test thoroughly** with actual ChatGPT Plus/Pro account
52-
7. **Submit PR** with clear description of changes
66+
6. **Test thoroughly** with the most appropriate validation for the change
67+
7. **Complete the pull request template** with summary, testing, and compliance details
68+
8. **Submit PR** with clear description of changes
69+
70+
Pull requests are automatically screened for incomplete or suspicious submissions. Legitimate contributions are still welcome, but low-signal PRs may be flagged for maintainer review before they move forward.
71+
72+
If a PR is flagged incorrectly, a maintainer can override the workflow with the `exempt` label after review.
5373

5474
## Reporting Issues
5575

@@ -107,30 +127,18 @@ We will decline features that:
107127

108128
## Code of Conduct
109129

110-
### Our Standards
111-
112-
**Encouraged:**
113-
- Respectful and constructive communication
114-
- Focus on legitimate use cases
115-
- Transparency about limitations and compliance
116-
- Helping other users with proper usage
117-
118-
**Not Acceptable:**
119-
- Requesting help with TOS violations
120-
- Promoting commercial misuse
121-
- Hostile or disrespectful behavior
122-
- Sharing credentials or tokens
130+
All contributors are expected to follow [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
123131

124132
## Questions?
125133

126134
For questions about:
127-
- **Plugin usage:** Open a GitHub issue
128-
- **OpenAI's terms:** Contact OpenAI support
129-
- **Contributing:** Open a discussion thread
135+
- **Plugin usage:** open a GitHub issue
136+
- **OpenAI's terms:** contact OpenAI support
137+
- **Contributing:** open an issue describing the proposed change
130138

131139
## License
132140

133-
By contributing, you agree that your contributions will be licensed under the MIT License with Usage Disclaimer (see LICENSE file).
141+
By contributing, you agree that your contributions will be licensed under the MIT License (see [LICENSE](LICENSE)).
134142

135143
---
136144

0 commit comments

Comments
 (0)