summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2015-10-29 11:57:29 -0700
committerAlex Crichton <alex@alexcrichton.com>2015-10-29 11:57:29 -0700
commit524e1374025e8162cccaf840db9e134257f8771c (patch)
tree29094b8fe9516db564eda27dab1917b23894b05a /README.md
parentb1fbefa73b3cc698029b05f8775f4a0041f9733c (diff)
downloadrust-libc-524e1374025e8162cccaf840db9e134257f8771c.tar.gz
Add numbered steps to add an API
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4d82511277..9530a3241d 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,14 @@ at, fear not! This crate has CI support which tests any binding against all
platforms supported, so you'll see failures if an API is added at the wrong
level or has different signatures across platforms.
+With that in mind, the steps for adding a new API are:
+
+1. Determine where in the module hierarchy your API should be added.
+2. Add the API.
+3. Send a PR to this repo.
+4. Wait for CI to pass, fixing errors.
+5. Wait for a merge!
+
## Platforms and Documentation
The following platforms are currently tested and have documentation available: