aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar nils-grepit <nils.fitinghoff@grepit.se> 2019-09-15 22:43:10 +0200
committerGravatar nils-grepit <nils.fitinghoff@grepit.se> 2019-09-15 22:43:10 +0200
commit476f29c4dde17e958dc2d3280acee3a19e87bb47 (patch)
treec8d6915e79e371ba776d0ee92072c1b8036075f0
parentc14f7d1ce90ad4957801336cefe65b7fa82fe63f (diff)
downloadrtic-476f29c4dde17e958dc2d3280acee3a19e87bb47.tar.gz
rtic-476f29c4dde17e958dc2d3280acee3a19e87bb47.tar.zst
rtic-476f29c4dde17e958dc2d3280acee3a19e87bb47.zip
add CONTRIBUTING.md and link to Matrix room
Diffstat (limited to '')
-rw-r--r--CONTRIBUTING.md16
-rw-r--r--README.md10
2 files changed, 26 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..b9d2f49b
--- /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 ff33da98..75661ec4 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