Skip to content

Commit a0fd4ff

Browse files
jonathanpallant9names
authored andcommitted
Update README with new Contact/CoC blocks
Taken from the rp-hal repo, for consistency.
1 parent 9d3b0ce commit a0fd4ff

File tree

1 file changed

+42
-5
lines changed

1 file changed

+42
-5
lines changed

README.md

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,50 @@ For a release build
4343
DEFMT_LOG=trace cargo run --release
4444
```
4545

46+
<!-- ROADMAP -->
47+
## Roadmap
48+
49+
NOTE These packages are under active development. As such, it is likely to
50+
remain volatile until a 1.0.0 release.
51+
52+
See the [open issues](https://github.com/rp-rs/rp-hal/issues) for a list of
53+
proposed features (and known issues).
54+
55+
## Contributing
56+
57+
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
58+
59+
The steps are:
60+
61+
1. Fork the Project by clicking the 'Fork' button at the top of the page.
62+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
63+
3. Make some changes to the code or documentation.
64+
4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
65+
5. Push to the Feature Branch (`git push origin feature/AmazingFeature`)
66+
6. Create a [New Pull Request](https://github.com/rp-rs/rp-hal/pulls)
67+
7. An admin will review the Pull Request and discuss any changes that may be required.
68+
8. Once everyone is happy, the Pull Request can be merged by an admin, and your work is part of our project!
69+
70+
## Code of Conduct
71+
72+
Contribution to this crate is organized under the terms of the [Rust Code of
73+
Conduct][CoC], and the maintainer of this crate, the [rp-rs team], promises
74+
to intervene to uphold that code of conduct.
75+
76+
[CoC]: CODE_OF_CONDUCT.md
77+
[rp-rs team]: https://github.com/orgs/rp-rs/teams/rp-rs
78+
4679
## License
4780

48-
This project is licensed under either of
81+
The contents of this repository are dual-licensed under the _MIT OR Apache
82+
2.0_ License. That means you can chose either the MIT licence or the
83+
Apache-2.0 licence when you re-use this code. See `MIT` or `APACHE2.0` for more
84+
information on each specific licence.
4985

50-
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
51-
http://www.apache.org/licenses/LICENSE-2.0)
86+
Any submissions to this project (e.g. as Pull Requests) must be made available
87+
under these terms.
5288

53-
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
89+
## Contact
5490

55-
at your option.
91+
Raise an issue: [https://github.com/rp-rs/rp2040-project-template/issues](https://github.com/rp-rs/rp2040-project-template/issues)
92+
Chat to us on Matrix: [#rp-rs:matrix.org](https://matrix.to/#/#rp-rs:matrix.org)

0 commit comments

Comments
 (0)