You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improve contributor guidance and clarify hosting reality
- CONTRIBUTING.md: replace JS-toolchain template residue (npm/standard
linter) with actual Python/MkDocs/JSON-Schema dev setup; add Code of
Conduct link, security disclosure path via GitHub PVR, branch naming
convention, DCO sign-off instruction, explicit MIT contribution
license clause, and spec-change discussion guidance.
- CLAUDE.md: correct hosting description — this repo is the spec source
of truth; the live site at agentcontrolstandard.ai is built from a
separate repo and does not deploy from here.
- Delete .github/workflows/deploy_mkdocs.yml — was failing on every
push (Pages not enabled, stack mismatch with the real Next.js site)
and served no purpose.
Copy file name to clipboardExpand all lines: CLAUDE.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,8 +89,10 @@ The documentation follows this hierarchy:
89
89
### Development Setup
90
90
This is a documentation-focused project built with:
91
91
-**UV** for Python dependency management (replaces pip)
92
-
-**MkDocs Material** for documentation generation
93
-
-**GitHub Pages** for hosting at agentcontrolstandard.org
92
+
-**MkDocs Material** for local documentation preview
93
+
94
+
### Hosting (decoupled from this repo)
95
+
This repository is the **source of truth for the ACS spec** (schema, hooks, events, AgBOM definitions, written specification). The marketing and docs site at **agentcontrolstandard.ai** is built and deployed independently from a separate repository — changes here do not propagate automatically. The `.org` and `.com` domains redirect to `.ai`.
94
96
95
97
### Roadmap Context
96
98
-**v0.1** (Current): Documentation, schemas, and requirements
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-13Lines changed: 28 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,10 @@ We're building trustworthy AI agents together. Your contributions make the futur
6
6
7
7
Search existing issues and pull requests to avoid duplicating efforts.
8
8
9
+
## Code of Conduct
10
+
11
+
This project follows our [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you agree to uphold it.
12
+
9
13
## How to Contribute
10
14
11
15
**Ideas**: Join issue discussions or start new ones. Your voice shapes ACS direction.
@@ -18,23 +22,28 @@ Search existing issues and pull requests to avoid duplicating efforts.
18
22
19
23
**Standards**: Help Improve ACS, extend CycloneDX, SPDX, SWID for agent components.
20
24
21
-
## Development Process
25
+
## Local Development
26
+
27
+
```bash
28
+
uv pip install -e .# install dependencies
29
+
uv run mkdocs serve # preview docs at http://localhost:8000
30
+
uv run mkdocs build # build static docs
31
+
```
22
32
23
-
1.**Fork the repository** - Create your own copy
24
-
2.**Sync branches** - Keep up-to-date with latest changes
25
-
3.**Create feature branch** - Work in isolation
26
-
4.**Make your changes** - Implement improvements
27
-
5.**Test thoroughly** - Ensure everything works
28
-
6.**Submit pull request** - Request merge to `main` branch
29
-
7.**Address feedback** - Collaborate on refinements
33
+
For prose contributions, follow the [editorial style guide](./STYLE.md). For schema contributions, validate `specification/ACS/acs_schema.json` against the JSON Schema spec before submitting.
30
34
31
-
## Code Standards
35
+
All submissions go through GitHub pull request review. See [GitHub's PR guide](https://docs.github.com/en/pull-requests) if you're new to the workflow.
32
36
33
-
We use [`standard`][standard-url] for consistent code style. Run `npm test` to check automatically.
37
+
## Development Process
34
38
35
-
All submissions require review via GitHub pull requests. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for guidance.
39
+
1.**Fork the repository** and clone your fork
40
+
2.**Create a feature branch** — use `feature/<short-description>` or `fix/<short-description>`
41
+
3.**Make your changes** following the style guide
42
+
4.**Sign your commits** with `git commit -s` (required by the DCO below)
For changes to the spec itself (`acs_schema.json`, hooks, events), open a [Discussion](https://github.com/Agent-Control-Standard/ACS/discussions) before submitting a PR — these affect downstream implementers and warrant a longer conversation.
38
47
39
48
## What We Need
40
49
@@ -51,6 +60,10 @@ Look for unassigned [Open Issues](https://github.com/Agent-Control-Standard/ACS/
51
60
52
61
Project maintainers handle formal releases. Focus on contributing great features and fixes.
53
62
63
+
## Reporting Security Issues
64
+
65
+
**Do not file public issues for security vulnerabilities.** Use GitHub's [private vulnerability reporting](https://github.com/Agent-Control-Standard/ACS/security/advisories/new) to disclose privately. We'll acknowledge within 72 hours and coordinate a fix and disclosure timeline with you.
66
+
54
67
## Developer's Certificate of Origin 1.1
55
68
56
69
By making a contribution to this project, I certify that:
@@ -72,11 +85,13 @@ By making a contribution to this project, I certify that:
72
85
including my sign-off) is maintained indefinitely and may be redistributed consistent
73
86
with this project or the open source license(s) involved.
74
87
88
+
By contributing, you agree that your contributions will be licensed under the [MIT License](./LICENSE.txt) — the same license that covers the rest of the project.
89
+
75
90
This guide is based on [github-contributing](https://raw.githubusercontent.com/standard/.github/refs/heads/master/CONTRIBUTING.md).
0 commit comments