Skip to content

Commit ee8528e

Browse files
laizhichao888laizhichao888
committed
feat: publish project governance skill
0 parents  commit ee8528e

69 files changed

Lines changed: 2628 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Bug report
2+
description: Report a reproducible defect in the Skill or local tools
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "Do not include credentials, private project data, or sensitive vulnerability details. Use SECURITY.md for security reports."
9+
- type: input
10+
id: version
11+
attributes:
12+
label: Version or revision
13+
placeholder: "0.1.0 or commit ID"
14+
validations:
15+
required: true
16+
- type: dropdown
17+
id: platform
18+
attributes:
19+
label: Platform
20+
options: [macOS, Windows, Linux, Other]
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: behavior
25+
attributes:
26+
label: Actual behavior and evidence
27+
description: Include sanitized output and exit code.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: expected
32+
attributes:
33+
label: Expected behavior
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: reproduce
38+
attributes:
39+
label: Minimal reproduction
40+
description: Use a temporary/synthetic project; remove private data.
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: checks
45+
attributes:
46+
label: Validation attempted
47+
placeholder: "Commands run, passed/failed/not run"

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Feature request
2+
description: Propose a general, offline, cross-platform governance improvement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Governance problem
10+
description: Describe the reusable problem, not only one project's convention.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: outcome
15+
attributes:
16+
label: Desired outcome and acceptance criteria
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: alternatives
21+
attributes:
22+
label: Alternatives considered
23+
- type: checkboxes
24+
id: constraints
25+
attributes:
26+
label: Project constraints
27+
options:
28+
- label: The proposal can remain free and open source.
29+
required: true
30+
- label: The proposal does not require telemetry, accounts, paid APIs, or a maintainer-controlled service.
31+
required: true
32+
- label: The proposal can support macOS, Windows, and Linux or documents a justified limitation.
33+
required: true

‎.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+
3+
Describe the reusable governance problem and the actual change.
4+
5+
## Scope
6+
7+
- Changed:
8+
- Explicitly not changed:
9+
- Risk level:
10+
11+
## Verification
12+
13+
- [ ] `python scripts/validate_skill.py`
14+
- [ ] `python scripts/validate_doc_links.py`
15+
- [ ] `python -m unittest discover -s tests -v`
16+
- [ ] User-facing changes are reflected in both READMEs
17+
18+
List exact commands/results and any unrun checks. Confirm the change adds no secrets, private project data, telemetry, hidden networking, paid dependency, or unsafe deletion behavior.

‎.github/workflows/test.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: test
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
validate:
12+
strategy:
13+
fail-fast: false
14+
matrix:
15+
os: [ubuntu-latest, windows-latest, macos-latest]
16+
python-version: ["3.10", "3.11", "3.12"]
17+
runs-on: ${{ matrix.os }}
18+
steps:
19+
- uses: actions/checkout@v4
20+
- uses: actions/setup-python@v5
21+
with:
22+
python-version: ${{ matrix.python-version }}
23+
- name: Validate Skill
24+
run: python scripts/validate_skill.py
25+
- name: Validate documentation links
26+
run: python scripts/validate_doc_links.py
27+
- name: Run unit tests
28+
run: python -m unittest discover -s tests -v
29+
- name: Install into temporary directory
30+
run: python scripts/install.py --destination "${{ runner.temp }}/project-governance"
31+
- name: Verify temporary installation
32+
run: python scripts/verify_install.py "${{ runner.temp }}/project-governance"
33+
- name: Uninstall temporary installation
34+
run: python scripts/uninstall.py --destination "${{ runner.temp }}/project-governance"

‎.gitignore‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
__pycache__/
2+
*.py[cod]
3+
*.egg-info/
4+
.pytest_cache/
5+
.mypy_cache/
6+
.coverage
7+
htmlcov/
8+
.DS_Store
9+
Thumbs.db
10+
.idea/
11+
.vscode/
12+
*.backup-*
13+
.project-governance-install.json

‎CHANGELOG.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
All notable changes are recorded here. The project follows semantic versioning where practical.
4+
5+
## [0.1.0] - 2026-07-13
6+
7+
### Added
8+
9+
- Risk-scaled, progressively disclosed project-governance Skill workflow.
10+
- Cross-platform atomic installer, manifest-safe uninstaller, and installation verifier.
11+
- Read-only project inspector and safe governance initializer.
12+
- Skill, Python syntax, safety, UTF-8, and relative-link validators.
13+
- Eleven templates, three fictional examples, standard-library tests, and three-platform CI.
14+
- English and Simplified Chinese documentation and open-source governance files.

‎CODE_OF_CONDUCT.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Code of Conduct
2+
3+
## Our standard
4+
5+
We commit to a respectful, inclusive, and harassment-free community. Be constructive, assume good intent while addressing impact, welcome different experience levels, and focus criticism on ideas and code.
6+
7+
Unacceptable conduct includes harassment, discrimination, threats, sexualized attention, deliberate intimidation, doxxing, publishing private information, sustained disruption, or retaliation against good-faith reports.
8+
9+
## Enforcement
10+
11+
Project maintainers may edit, reject, or remove contributions and temporarily or permanently restrict participation when behavior harms the community. Report conduct concerns privately to the maintainers through the repository's available private contact mechanism. Do not open a public issue containing personal or sensitive details.
12+
13+
Maintainers will protect reporter privacy as far as practical, review evidence fairly, avoid conflicts of interest, and communicate proportionate outcomes. This policy applies in project spaces and when representing the project elsewhere.

‎CONTRIBUTING.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
3+
Contributions are welcome under the MIT License.
4+
5+
## Principles
6+
7+
- Keep the Skill language/framework/business/OS neutral.
8+
- Prefer Python 3.10+ standard library and offline behavior.
9+
- Add no telemetry, accounts, paid services, hidden networking, activation, or remote control.
10+
- Preserve safe defaults: no overwrite, no unknown-file deletion, no untrusted project execution.
11+
- Keep `SKILL.md` concise and route detail through relevant references.
12+
13+
## Workflow
14+
15+
1. Open an issue for broad behavior or compatibility changes.
16+
2. Add or update a focused `unittest` before changing Python behavior and observe the expected failure.
17+
3. Implement the smallest complete change with type annotations and `pathlib`.
18+
4. Run:
19+
20+
```sh
21+
python3 scripts/validate_skill.py
22+
python3 scripts/validate_doc_links.py
23+
python3 -m unittest discover -s tests -v
24+
```
25+
26+
5. Update both READMEs when user-facing behavior changes.
27+
6. Submit a focused pull request using the repository template.
28+
29+
Do not include project data, credentials, generated caches, unrelated refactors, or claims for tests you did not execute. By contributing, you agree that your contribution is licensed under the project's MIT License.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Codex Project Governance Skill contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)