Skip to content

Commit 7751483

Browse files
committed
Add testing and documentation to contributing section in README.md
1 parent bed6a8d commit 7751483

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

rust/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,18 @@ cargo doc --no-deps --open -p binaryninja
138138

139139
If you're thinking of contributing to the Rust API, we encourage you to join the #rust-api channel in our [Slack](https://slack.binary.ninja), especially for large-effort PRs.
140140

141+
### Testing
142+
143+
When contributing new APIs or refactoring existing APIs it is vital that you test your code! If you do not have a
144+
headless supported license you should still be able to write them and open your PR. Once open a
145+
maintainer will approve tests to run and from there you can refine the test so that it passes in CI.
146+
147+
### Documentation
148+
149+
When refactoring or making new changes make sure that the documentation for the respective APIs is up-to-date and not missing.
150+
Much of the APIs documentation exists only in the python bindings, so use that as a guide. If there is an API that confuses you
151+
it will likely confuse someone else, and you should make an issue or ask for guidance in the Slack channel above.
152+
141153
---
142154

143155
#### Attribution

0 commit comments

Comments
 (0)