swaits
fa3f2e8fb0
Theme: documentation and project polish. No public-API changes; this is the v0.5 release that elevates heuropt's docs/onboarding/governance to bar-setting status. Adds: - mdbook user guide at docs/book/ with intro, getting-started, defining-problems, choosing-an-algorithm, cookbook (7 recipes), comparison vs other libraries, stability/SemVer, migration guides. Deploys to https://swaits.github.io/heuropt/ via .github/workflows/ docs.yml. - Runnable rustdoc examples on every algorithm (35 of them), all exercised by cargo test --doc. - Three real-world examples: portfolio.rs (multi-obj with budget constraint), hyperparam_tuning.rs (BO + TPE), scheduling.rs (permutation via SA + SwapMutation against Smith's-rule oracle). - Governance: CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md (adopting builderscode.org's Builder's Code of Conduct), GitHub issue templates, PR template. Polishes: - README hero with badges + user-guide link. - lib.rs crate-level docs. - CHANGELOG entry for 0.5.0. Bumps Cargo.toml to 0.5.0.
44 lines
1.0 KiB
Markdown
44 lines
1.0 KiB
Markdown
# Code of Conduct
|
|
|
|
heuropt adopts the [Builder's Code of Conduct](https://builderscode.org/),
|
|
version 1.0.
|
|
|
|
A Code of Conduct for people who build things.
|
|
|
|
## The Rule
|
|
|
|
> "Stay professional. Stay technical."
|
|
|
|
## Expected
|
|
|
|
- Contribute constructively.
|
|
- Respect others' time and work.
|
|
- Focus on the work and its technical merit.
|
|
|
|
## Not Welcome
|
|
|
|
- Harassment, name-calling, or personal attacks.
|
|
- Trolling, spamming, or derailing discussions.
|
|
- Discussions about contributors rather than their contributions.
|
|
|
|
## Enforcement
|
|
|
|
Violations result in:
|
|
|
|
1. **Warning** — first offense.
|
|
2. **Temporary suspension** — repeated or serious violations.
|
|
3. **Permanent ban** — continued violations.
|
|
|
|
Maintainers can remove, block, or ban anyone who disrupts the project.
|
|
|
|
## Reporting
|
|
|
|
Email **steve@waits.net** with `[heuropt CoC]` in the subject line.
|
|
Reports are handled confidentially.
|
|
|
|
---
|
|
|
|
The Builder's Code of Conduct is dedicated to the public domain under
|
|
CC0 1.0 Universal. You may use, modify, and distribute it freely
|
|
without attribution.
|