Skip to content

docs: add CONTRIBUTING.md and README badges#36

Merged
lostmygithubaccount merged 1 commit into
mainfrom
agent3/oss-hygiene-readme
Apr 13, 2026
Merged

docs: add CONTRIBUTING.md and README badges#36
lostmygithubaccount merged 1 commit into
mainfrom
agent3/oss-hygiene-readme

Conversation

@lostmygithubaccount
Copy link
Copy Markdown
Member

Summary

  • Add 5 shields at the top of README (Release, PyPI, crates.io, CI, License) matching the bookmarks / db convention across dkdc-io/*.
  • Add CONTRIBUTING.md covering dev setup, check/format workflow, crate map, PR conventions, and bug-report template.
  • Link from README's new Contributing section to CONTRIBUTING.md.

No functional changes. Docs + metadata only.

Test plan

  • bin/check green
  • Badge URLs resolve once main is updated (Release/PyPI/crates.io already published; CI badge depends on this workflow file)

🤖 Generated with Claude Code

Match the bookmarks/db convention with 5 shields at the top
(Release, PyPI, crates.io, CI, License) and add a CONTRIBUTING.md
covering dev setup, workflow, commit style, and bug-report template.
Link from README to CONTRIBUTING. No functional changes.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@lostmygithubaccount lostmygithubaccount merged commit bac425e into main Apr 13, 2026
1 check passed
@lostmygithubaccount lostmygithubaccount deleted the agent3/oss-hygiene-readme branch April 13, 2026 03:19
lostmygithubaccount added a commit that referenced this pull request Apr 13, 2026
Bumps all Rust crates and the Python package from 0.2.1 to 0.3.0. This
minor bump reflects one breaking change in the dkdc-draw-core public API
surface (pub -> pub(crate) demotions in #42), accumulated with the
non-breaking work from this cycle:

  - #35: arrow snap-to-shape connection points
  - #36: CONTRIBUTING.md + README badges
  - #37: integration tests for draw-core public API
  - #38: Rust + Python hello-world examples
  - #39: CHANGELOG.md scaffolding
  - #40: surgical clippy opt-ins workspace-wide
  - #41: sample gallery (5 drawings × json/svg/png)
  - #42: pub -> pub(crate) demotions (BREAKING)
  - #43: Python test coverage 5 -> 27

See CHANGELOG.md for the 0.3.0 section and migration notes for the
demoted symbols.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@lostmygithubaccount lostmygithubaccount mentioned this pull request Apr 13, 2026
4 tasks
lostmygithubaccount added a commit that referenced this pull request Apr 13, 2026
Bumps all Rust crates and the Python package from 0.2.1 to 0.3.0. This
minor bump reflects one breaking change in the dkdc-draw-core public API
surface (pub -> pub(crate) demotions in #42), accumulated with the
non-breaking work from this cycle:

  - #35: arrow snap-to-shape connection points
  - #36: CONTRIBUTING.md + README badges
  - #37: integration tests for draw-core public API
  - #38: Rust + Python hello-world examples
  - #39: CHANGELOG.md scaffolding
  - #40: surgical clippy opt-ins workspace-wide
  - #41: sample gallery (5 drawings × json/svg/png)
  - #42: pub -> pub(crate) demotions (BREAKING)
  - #43: Python test coverage 5 -> 27

See CHANGELOG.md for the 0.3.0 section and migration notes for the
demoted symbols.

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant