From 476f29c4dde17e958dc2d3280acee3a19e87bb47 Mon Sep 17 00:00:00 2001 From: nils-grepit Date: Sun, 15 Sep 2019 22:43:10 +0200 Subject: [PATCH] add CONTRIBUTING.md and link to Matrix room --- CONTRIBUTING.md | 16 ++++++++++++++++ README.md | 10 ++++++++++ 2 files changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..b9d2f49b52 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# Contributing +## New features +New features should go through the [RFC process][rfcs] before a Pull Request is made to this repository. + +[rfcs](https://github.com/rtfm-rs/rfcs) + +## Bugs +Report bugs by creating an issue in this repository. + +## Pull Requests +Please make pull requests against the master branch. + +Always use rebase instead of merge when bringing in changes from master to your feature branch. + +## Writing documentation +Documentation improvements are always welcome. The source for the book is in `book/` and API documentation is generated from the source code. diff --git a/README.md b/README.md index ff33da9859..75661ec41c 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,16 @@ A concurrency framework for building real time systems. ## [API reference](https://japaric.github.io/rtfm5/api/rtfm/index.html) +## Chat +Join us and talk about RTFM in the [Matrix room][matrix-room]. + +[matrix-room]: https://matrix.to/#/!yafYEipFNsXDdwiHMT:matrix.org + +## Contributing +New features and big changes should go through the RFC process in the [dedicated RFC repository][rfcs]. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. + +[rfcs]: https://github.com/rtfm-rs/rfcs + ## Acknowledgments This crate is based on [the RTFM language][rtfm-lang] created by the Embedded