245: add CONTRIBUTING.md and link to Matrix room r=korken89 a=nils-grepit

Inspired by the Rust lang [CONTRIBUTING.md](https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md), but small. There might be more we want to use from there.

246: turn git deps into crates.io deps r=korken89 a=japaric

required for publishing v0.5.0-beta

Co-authored-by: nils-grepit <nils.fitinghoff@grepit.se>
Co-authored-by: Jorge Aparicio <jorge@japaric.io>
This commit is contained in:
bors[bot] 2019-09-15 21:24:01 +00:00 committed by GitHub
commit 8135ed4999
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 28 additions and 4 deletions

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.

View file

@ -48,7 +48,7 @@ required-features = ["__v7"]
[dependencies] [dependencies]
cortex-m = "0.6.0" cortex-m = "0.6.0"
cortex-m-rtfm-macros = { path = "macros" } cortex-m-rtfm-macros = { path = "macros" }
rtfm-core = { git = "https://github.com/rtfm-rs/rtfm-core" } rtfm-core = "0.3.0-beta.1"
cortex-m-rt = "0.6.9" cortex-m-rt = "0.6.9"
heapless = "0.5.0" heapless = "0.5.0"

View file

@ -47,6 +47,16 @@ A concurrency framework for building real time systems.
## [API reference](https://rtfm.rs/api/rtfm/index.html) ## [API reference](https://rtfm.rs/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].
[rfcs]: https://github.com/rtfm-rs/rfcs
## Acknowledgments ## Acknowledgments
This crate is based on [the RTFM language][rtfm-lang] created by the Embedded This crate is based on [the RTFM language][rtfm-lang] created by the Embedded

View file

@ -18,9 +18,7 @@ proc-macro = true
proc-macro2 = "1" proc-macro2 = "1"
quote = "1" quote = "1"
syn = "1" syn = "1"
rtfm-syntax = "0.4.0-beta.1"
[dependencies.rtfm-syntax]
git = "https://github.com/rtfm-rs/rtfm-syntax"
[features] [features]
heterogeneous = [] heterogeneous = []