rust-bitcoin / rust-bitcoin/rust-bitcoin
Test complete public API in 1.0 crates
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.7k
- Forks
- 1k
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 88
Description
We should IMO aim to have integration tests that hit the whole public API before we release v1.0 versions. Up to now we have been relying on rustdoc tests to give us full API coverage but because of the nuance in how rustdoc tests are run (in workspaces) and also the fact that they are harder to read, it would be useful to have these tests in the tests/ directory.
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 reviewing the existing rustdoc tests and the tests/ directories in the crates intended for v1.0 releases, paying attention to workspace test behavior. Done means integration tests cover the complete public API of each 1.0 crate and can be run reliably as workspace tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100