Skip to content

refactor(root): relocate the contributing guide into .github/ #220

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
hyperpolymath merged 1 commit into from
Sep 19, 2026
Merged

refactor(root): relocate the contributing guide into .github/ #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
71 changes: 71 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Contributing

Thank you for your interest in contributing! We follow a “Dual-Track”
architecture where human-readable documentation lives in the root and
machine-readable policies live in `.machine_readable/`.

## How to Contribute

We welcome contributions in many forms:

- **Code:** Improving the core stack or extensions

- **Documentation:** Enhancing docs or AI manifests

- **Testing:** Adding property-based tests or formal proofs

- **Bug reports:** Filing clear, reproducible issues

## Getting Started

1. **Read the AI Manifest:** Start with `0-AI-MANIFEST.a2ml` (if
present) to understand the repository structure.

2. **Environment:** Use `nix` `develop` or `direnv` `allow` to set up
your tools.

3. **Task Runner:** Use `just` to see available commands (`just`
`--list`).

## Development Workflow

### Branch Naming

docs/short-description # Documentation
test/what-added # Test additions
feat/short-description # New features
fix/issue-number-description # Bug fixes
refactor/what-changed # Code improvements
security/what-fixed # Security fixes

### Commit Messages

We follow [Conventional Commits](https://www.conventionalcommits.org/):

<type>(<scope>): <description>

[optional body]

[optional footer]

Types: `feat`, `fix`, `docs`, `test`, `refactor`, `ci`, `chore`,
`security`

## Reporting Bugs

Before reporting: 1. Search existing issues 2. Check if it’s already
fixed in `main`

When reporting, include: - Clear, descriptive title - Environment
details (OS, versions, toolchain) - Steps to reproduce - Expected vs
actual behaviour

## Code of Conduct

All contributors are expected to adhere to our [Code of
Conduct](CODE_OF_CONDUCT.md).

## License

By contributing, you agree that your contributions will be licensed
under the same license as the project (see LICENSE).
2 changes: 1 addition & 1 deletion .hypatia/scan-cache/fix-http-to-https.hashes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ b68fc56ff40000ce91d66e90dfc01dc3cd15778c6226da8654d96c6c133ebf60 bindings/elixi
fa340020278b3ae2d475ef9d3bcfd2081d74050f95cb43b6eb4b8aeef894c10d bindings/purescript/Proven/SafeFloat.js
759d0c5c0e76bd0deddeecb69a78f41bc8990fbc57ede0553b47c62025a1b9c4 bindings/rust/src/safe_datetime.rs
d11b5f805e9dc9c7d61381d639e53d472db2cac486866cd7ac6833b83451e65e bindings/mustache/helpers/proven-helpers.js
e0ea092234708d29ab1c3f7285dab3465bc035fa0705f555204df64305bace2e CONTRIBUTING.adoc
e0ea092234708d29ab1c3f7285dab3465bc035fa0705f555204df64305bace2e ../../.github/CONTRIBUTING.md
fd2f75e68af5c4c17657a967447d90514d1721df5c505088efc5d4ad2b89d506 .devcontainer/post-create.sh
f2c61c0849b329ea48f75577f1b1016f1dd62a7a5cca55a2f29c6cc64cab4517 .github/workflows/publish-ghcr.yml
1016d843b02e77760b1ffe6af8bbb6bf069347f56a23f766935474323acbdac2 bindings/elixir/lib/proven/safe_version.ex
Expand Down
71 changes: 0 additions & 71 deletions CONTRIBUTING.adoc
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions PROVEN-COMPREHENSIVE-ANALYSIS-2026-01-30.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Testing:
* *Test Files:* 29 property tests + 20 unit tests ✓
* *Fuzzing:* ClusterFuzzLite integration ✓
* *CI/CD:* GitHub Actions workflows ✓
* *Documentation:* README.adoc ✓, CONTRIBUTING.adoc ✓, SECURITY.md ✓
* *Documentation:* README.adoc ✓, .github/CONTRIBUTING.md ✓, SECURITY.md ✓

==== Language Bindings (89 targets)

Expand Down Expand Up @@ -422,7 +422,7 @@ BSD)
* META.scm (ADRs, design rationale)
* ECOSYSTEM.scm (project relationships)
* README.adoc (excellent, detailed)
* CONTRIBUTING.adoc ✓
* .github/CONTRIBUTING.md ✓
* CODE_OF_CONDUCT.md ✓
* SECURITY.md ✓
* CHANGELOG.md ✓
Expand Down Expand Up @@ -514,7 +514,7 @@ Based on Rhodium Standard Repositories (RSR):
* [x] META.scm present with ADRs
* [x] ECOSYSTEM.scm present
* [x] README.adoc comprehensive
* [x] CONTRIBUTING.adoc
* [x] .github/CONTRIBUTING.md
* [x] CODE_OF_CONDUCT.md
* [x] SECURITY.md
* [x] LICENSE files (MPL-2.0-or-later)
Expand Down
2 changes: 1 addition & 1 deletion README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1947,7 +1947,7 @@ Crashes are a choice. Choose otherwise.

== Contributing

We welcome contributions! See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc].
We welcome contributions! See link:.github/CONTRIBUTING.md[.github/CONTRIBUTING.md].

Especially needed:
* Language binding maintainers (Scala, F#, Crystal, etc.)
Expand Down
Loading