mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-12-24 02:49:34 +01:00
Code Issues Projects Releases Packages Wiki Activity

add CONTRIBUTING.md and link to Matrix room

Browse source
This commit is contained in:
nils-grepit 2019-09-15 22:43:10 +02:00
parent c14f7d1ce9
commit 476f29c4dd
2 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.md Normal file
View file

@ -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.

10
README.md
View file

@ -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