Skip to content

Commit 3ab238d

Browse files
committed
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.
1 parent 92e3fbf commit 3ab238d

3 files changed

Lines changed: 32 additions & 77 deletions

File tree

.github/workflows/deploy_mkdocs.yml

Lines changed: 0 additions & 62 deletions
This file was deleted.

CLAUDE.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,10 @@ The documentation follows this hierarchy:
8989
### Development Setup
9090
This is a documentation-focused project built with:
9191
- **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`.
9496

9597
### Roadmap Context
9698
- **v0.1** (Current): Documentation, schemas, and requirements

CONTRIBUTING.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ We're building trustworthy AI agents together. Your contributions make the futur
66

77
Search existing issues and pull requests to avoid duplicating efforts.
88

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+
913
## How to Contribute
1014

1115
**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.
1822

1923
**Standards**: Help Improve ACS, extend CycloneDX, SPDX, SWID for agent components.
2024

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+
```
2232

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.
3034

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.
3236

33-
We use [`standard`][standard-url] for consistent code style. Run `npm test` to check automatically.
37+
## Development Process
3438

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)
43+
5. **Open a pull request** against `main`
44+
6. **Address review feedback** to land your change
3645

37-
[standard-url]: https://github.com/standard/standard
46+
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.
3847

3948
## What We Need
4049

@@ -51,6 +60,10 @@ Look for unassigned [Open Issues](https://github.com/Agent-Control-Standard/ACS/
5160

5261
Project maintainers handle formal releases. Focus on contributing great features and fixes.
5362

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+
5467
## Developer's Certificate of Origin 1.1
5568

5669
By making a contribution to this project, I certify that:
@@ -72,11 +85,13 @@ By making a contribution to this project, I certify that:
7285
including my sign-off) is maintained indefinitely and may be redistributed consistent
7386
with this project or the open source license(s) involved.
7487

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+
7590
This guide is based on [github-contributing](https://raw.githubusercontent.com/standard/.github/refs/heads/master/CONTRIBUTING.md).
7691

7792
## Community
7893

7994
- **[GitHub Discussions](https://github.com/Agent-Control-Standard/ACS/discussions)**: Ask questions, share ideas
8095
- **[Issues](https://github.com/Agent-Control-Standard/ACS/issues)**: Report bugs, request features
8196

82-
We're building the future of AI agent observability and control. Join us.
97+
We're building the future of AI agent observability and control. Join us.

0 commit comments

Comments
 (0)