Skip to content

Commit f3a932b

Browse files
RichardGeorgeDavisRichardGeorgeDavis
committed
Polish docs and GitHub repository setup
1 parent 49c5faf commit f3a932b

33 files changed

Lines changed: 479 additions & 234 deletions

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Code of Conduct
2+
3+
## Our standard
4+
5+
This project expects direct, respectful, technically grounded collaboration.
6+
7+
Examples of expected behavior:
8+
9+
- communicate clearly and in good faith
10+
- critique ideas, code, and decisions without attacking people
11+
- keep discussions practical, specific, and relevant to the project
12+
- accept feedback and correct mistakes quickly
13+
- respect different levels of experience and different technical backgrounds
14+
15+
Examples of unacceptable behavior:
16+
17+
- harassment, insults, or personal attacks
18+
- bad-faith arguing, trolling, or repeated derailing
19+
- publishing private information without permission
20+
- discriminatory or exclusionary language or conduct
21+
- repeated low-signal noise after maintainers ask to refocus
22+
23+
## Scope
24+
25+
This code of conduct applies in issues, pull requests, discussions, and other project spaces.
26+
27+
## Enforcement
28+
29+
Project maintainers may edit, remove, or moderate content that violates this code of conduct. Repeated or severe violations may lead to temporary or permanent exclusion from the project spaces.
30+
31+
## Reporting
32+
33+
For conduct concerns, contact the maintainer privately rather than escalating in public.

‎.github/CONTRIBUTING.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing
2+
3+
Thanks for contributing to Codex Workspace.
4+
5+
This repository is primarily for:
6+
7+
- workspace-level documentation
8+
- workspace structure, templates, and scripts
9+
- the vendored `repos/workspace-hub/` application
10+
11+
Open an issue before starting broad structural changes, major runtime-policy changes, or large UI shifts in Workspace Hub.
12+
13+
## Core rules
14+
15+
- Keep unrelated repositories independent.
16+
- Share caches, not installs.
17+
- Do not make ServBay mandatory.
18+
- Put canonical workspace docs in `docs/`.
19+
- Keep repo-local docs with the repo they describe.
20+
21+
## Local setup
22+
23+
Clone the repository and review the main docs:
24+
25+
```bash
26+
git clone https://github.com/RichardGeorgeDavis/Codex-Workspace.git
27+
cd Codex-Workspace
28+
```
29+
30+
For documentation, metadata, or script-only changes, no additional setup is required.
31+
32+
For `workspace-hub` changes:
33+
34+
```bash
35+
cd repos/workspace-hub
36+
pnpm install
37+
pnpm lint
38+
pnpm typecheck
39+
pnpm build
40+
```
41+
42+
## Pull requests
43+
44+
Please keep pull requests focused.
45+
46+
- Explain the problem and the change clearly.
47+
- Update docs when behaviour or conventions change.
48+
- Include verification steps for `workspace-hub` changes.
49+
- Avoid unrelated cleanup in the same PR.
50+
51+
## Scope guidance
52+
53+
Good contribution targets:
54+
55+
- README and docs improvements
56+
- workspace templates and scripts
57+
- metadata conventions
58+
- Workspace Hub UX, runtime handling, and repo classification
59+
60+
Avoid in this repo:
61+
62+
- adding unrelated project code under the workspace root
63+
- introducing shared dependency installs across independent repos
64+
- hard-coding one runtime model for every stack
65+
66+
## Questions
67+
68+
- Review [README.md](../README.md)
69+
- Start with [docs/README.md](../docs/README.md)
70+
- Open an issue if the intended change affects workspace conventions
71+
72+
By contributing, you agree that your contributions will be licensed under the [MIT License](../LICENSE).

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
custom: ["https://www.paypal.com/donate/?hosted_button_id=Z9ET7KXE4MMZS"]

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Bug report
3+
about: Report a reproducible problem in the workspace docs, tooling, or Workspace Hub.
4+
title: "[Bug] "
5+
labels: ["bug"]
6+
assignees: []
7+
---
8+
9+
## Summary
10+
11+
Describe the problem clearly.
12+
13+
## Area
14+
15+
- Workspace docs
16+
- Workspace scripts or templates
17+
- Workspace Hub
18+
- Repo metadata or manifests
19+
- Other
20+
21+
## Steps to reproduce
22+
23+
1.
24+
2.
25+
3.
26+
27+
## Expected result
28+
29+
What should have happened?
30+
31+
## Actual result
32+
33+
What happened instead?
34+
35+
## Environment
36+
37+
- OS:
38+
- Node version:
39+
- Package manager:
40+
- Browser, if relevant:
41+
42+
## Additional context
43+
44+
Include screenshots, logs, or related file paths if they help.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Workspace docs
4+
url: https://github.com/RichardGeorgeDavis/Codex-Workspace/tree/main/docs
5+
about: Start with the workspace docs before opening a broad structure or usage question.

‎.github/ISSUE_TEMPLATE/docs_improvement.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Docs improvement
3+
about: Suggest a documentation fix or improvement.
4+
title: "[Docs] "
5+
labels: ["documentation"]
6+
assignees: []
7+
---
8+
9+
## Summary
10+
11+
What is unclear, missing, outdated, or poorly structured?
12+
13+
## Location
14+
15+
Which file or section needs work?
16+
17+
## Suggested change
18+
19+
Describe the wording, structure, or examples you want to improve.
20+
21+
## Why this matters
22+
23+
Explain how this would make the repo easier to understand or use.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Feature request
3+
about: Suggest an improvement to Codex Workspace or Workspace Hub.
4+
title: "[Feature] "
5+
labels: ["enhancement"]
6+
assignees: []
7+
---
8+
9+
## Summary
10+
11+
Describe the change you want.
12+
13+
## Problem it solves
14+
15+
What workflow, limitation, or pain point does this address?
16+
17+
## Proposed approach
18+
19+
Describe the preferred solution.
20+
21+
## Alternatives considered
22+
23+
List any other approaches you considered.
24+
25+
## Scope
26+
27+
- Workspace docs
28+
- Workspace scripts or templates
29+
- Workspace Hub
30+
- Repo metadata or manifests
31+
- Other
32+
33+
## Additional context
34+
35+
Add examples, screenshots, or reference repos if useful.

‎.github/SECURITY.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Security Policy
2+
3+
## Reporting a vulnerability
4+
5+
Do not open a public issue for a suspected security problem.
6+
7+
Instead, contact the maintainer privately with:
8+
9+
- a clear description of the issue
10+
- affected files or areas
11+
- reproduction steps or proof of concept
12+
- impact assessment if known
13+
14+
Use a private channel you already have with the maintainer. If none exists, open a minimal public issue asking for a private contact path without disclosing the vulnerability details.
15+
16+
## Response expectations
17+
18+
Security reports will be reviewed as time permits. Initial acknowledgment is best effort rather than guaranteed.
19+
20+
## Scope
21+
22+
This policy covers:
23+
24+
- workspace-level scripts and templates
25+
- workspace documentation that could cause unsafe usage
26+
- the vendored `repos/workspace-hub/` application
27+
28+
It does not cover third-party repositories stored under `repos/` unless the issue is caused by workspace-owned tooling or metadata.

‎.github/SUPPORT.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Support
2+
3+
## Getting help
4+
5+
For usage questions or workflow confusion:
6+
7+
1. Read [README.md](../README.md)
8+
2. Start with [docs/README.md](../docs/README.md)
9+
3. Review [repos/workspace-hub/README.md](../repos/workspace-hub/README.md) for Hub-specific behavior
10+
11+
## Where to open issues
12+
13+
- Open a bug report for reproducible problems
14+
- Open a docs issue for unclear or missing documentation
15+
- Open a feature request for focused improvements
16+
17+
## Before opening an issue
18+
19+
- confirm the question is about this repository rather than a separate repo stored under `repos/`
20+
- include the affected file paths or workspace area
21+
- include runtime steps if the problem involves Workspace Hub

‎.github/pull_request_template.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Summary
2+
3+
Explain the change in 2-5 bullets.
4+
5+
## Scope
6+
7+
- Workspace docs
8+
- Workspace scripts or templates
9+
- Workspace Hub
10+
- Repo metadata or manifests
11+
- Other
12+
13+
## Verification
14+
15+
List the checks you ran or explain why no runtime verification was needed.
16+
17+
## Docs
18+
19+
- Updated docs where behavior or conventions changed
20+
- No docs update needed
21+
22+
## Checklist
23+
24+
- [ ] The change is focused and does not mix unrelated cleanup
25+
- [ ] Repo independence is preserved
26+
- [ ] No shared dependency install structure was introduced
27+
- [ ] ServBay was kept optional
28+
- [ ] New behavior is documented where needed

0 commit comments

Comments
 (0)