microsoft / microsoft/rust-symcrypt
Update documentation for binding generation
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 72
- Forks
- 15
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 11
Description
Write rust-symcrypt developer docs.
Should include:
- Procedure for updating
rust-symcryptandsymcrypt-sysversion ex:cargo publish --dry-run - Procedure for updating underlying
SymCryptversion. This would be for both the static linking, as well as bindings (buildinfo.h) - Procedure for updating the bindings / adding a new algorithm to
rust-symcrypt - Dev checks that must be preformed before checking in a branch, ex: (clippy, cargo fmt, updating the release draft, checking bindings)
- How to generate new bindings
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing developer documentation and the binding-generation workflow for rust-symcrypt and symcrypt-sys. Document version updates, including SymCrypt and buildinfo.h changes, binding or algorithm updates, cargo publish --dry-run, clippy, cargo fmt, release-draft updates, binding checks, and binding generation; done means each listed procedure is reproducible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100