summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2017-04-26 15:44:19 -0700
committerAlex Crichton <alex@alexcrichton.com>2017-04-26 15:44:19 -0700
commit97a158b3a80073e68286c6b592755a9022017950 (patch)
tree470a177de4c9c9d99e7a5420340774cf4bb853f1 /README.md
parent288ed55dd75ec89b3d56efca198ee7c0be98906d (diff)
downloadrust-libc-97a158b3a80073e68286c6b592755a9022017950.tar.gz
Add instructions of how to make a release
Anyone can do it!
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 83ae7b9352..67535d211e 100644
--- a/README.md
+++ b/README.md
@@ -98,6 +98,25 @@ We have two automated tests running on [Travis](https://travis-ci.org/rust-lang/
2. Style checker
- `rustc ci/style.rs && ./style src`
+### Releasing your change to crates.io
+
+Now that you've done the amazing job of landing your new API or your new
+platform in this crate, the next step is to get that sweet, sweet usage from
+crates.io! The only next step is to bump the version of libc and then publish
+it. If you'd like to get a release out ASAP you can follow these steps:
+
+1. Update the version number in `Cargo.toml`, you'll just be bumping the patch
+ version number.
+2. Run `cargo update` to regenerate the lockfile to encode your version bump in
+ the lock file. You may pull in some other updated dependencies, that's ok.
+3. Send a PR to this repository. It should [look like this][example], but it'd
+ also be nice to fill out the description with a small rationale for the
+ release (any rationale is ok though!)
+4. Once merged the release will be tagged and published by one of the libc crate
+ maintainers.
+
+[example]: https://github.com/rust-lang/libc/pull/583
+
## Platforms and Documentation
The following platforms are currently tested and have documentation available: