Skip to content

docs: add CONTRIBUTING.md for AI accessibility #347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gosunuts merged 5 commits into from
Aug 28, 2026
+27 −8
Merged

docs: add CONTRIBUTING.md for AI accessibility #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
45bba3c
docs: add CONTRIBUTING.md for AI accessibility
gosunuts Aug 28, 2026
8c898dd
docs: clarify contribution policy boundaries
gosunuts Aug 28, 2026
adf8403
docs: distinguish human and AI contributions
gosunuts Aug 28, 2026
02024b1
docs: distinguish human and AI contributions
gosunuts Aug 28, 2026
7a9e3cb
docs: tighten AI contribution policy
gosunuts Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing

`AGENTS.md` is the core implementation guide. This file is contribution policy.

## For Human Contributors

Thank you for contributing to Portal.

Human review and judgment are especially important in the parts of the project where correctness depends on context, tradeoffs, and careful validation.

Human contributions may extend into core implementation, protocol behavior, trust boundaries, identity, transport, cryptography, and architecture when the change is well understood and properly justified.

Please follow `AGENTS.md` for implementation rules.

## For AI Contributors

AI contributions are strongly encouraged on the user-facing and integration surface of Portal.

This includes CLI behavior, logs, diagnostics, documentation, skills, configuration ergonomics, installer and service integration, local harnesses, and other friction encountered while using Portal.

AI contributors may file issues, reviews, and improvement proposals in these areas without prior assignment.

Repeated instructions, parsing workarounds, ambiguous output, and integration-specific exceptions should be treated as signs that the Portal surface itself may need improvement. Prefer fixing the surface and removing the workaround.

Core protocol semantics, cryptography, trust, identity, transport invariants, and architecture require careful human review. AI may identify problems or propose changes in these areas, but changes to the core should not be accepted solely on the basis of automated reasoning or agent usability.
5 changes: 1 addition & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,7 @@ relay, open a pull request to add your relay URL to `registry.json`.

## Contributing

1. Fork the repository.
2. Create a feature branch (`git checkout -b feature/amazing-feature`).
3. Make the change with focused tests or docs.
4. Open a pull request.
See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

Expand Down
5 changes: 1 addition & 4 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,10 +188,7 @@ https://raw.githubusercontent.com/gosuda/portal-tunnel/main/registry.json

## 贡献

1. Fork 这个仓库。
2. 创建功能分支（`git checkout -b feature/amazing-feature`）。
3. 用聚焦的测试或文档完成修改。
4. 打开 pull request。
见 [CONTRIBUTING.md](CONTRIBUTING.md)。

## 许可证

Expand Down
Loading