Vector35 / Vector35/binaryninja-api
API unit tests have no documentation
Open
Nobody has claimed this yet.
Component: API
Effort: Trivial
Impact: Low
- Dominant language
- C++
- Stars
- 1.3k
- Forks
- 298
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 19
Description
Bug Description:
We need to document how to use the API unit tests in here so that people can run them before making pull requests.
Contributor guide
No contributing guide indexed for this repository
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 with suite/api_test.py to understand how the API unit tests are organized and invoked. Document the steps needed to run them before opening a pull request, with completion shown by clear usage instructions that let contributors run the tests independently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100