Skip to content

Add testing / contributing / roadmap information to readme #84

@kamathba

Description

@kamathba

The top-level README for this module is very useful for getting started but could have a few more links for people coming into the project from any direction (rust embedded, zephyr background, no experience, etc). Some of this could already be planned or in progress but I didn't find it (in which case, sorry for repeat)

Proposed changes

  • Some sort of doc link to latest gh-pages zephyr project documentation
  • Add a roadmap header, could link to original RFC, as well as follow on RFCs plus maybe any other links to inform peoples understanding of where the project is headed.
  • Add a testing header, could start with something as simple as tl;dr ./zephyr/scripts/twister -T modules/lang/rust/tests/ plus maybe a link that discusses rustup / toolchain prereqs
  • Add a contributing header, that lists all the places where discussion for development work happens for this project. This is actually the thing I was most interested in and the other ideas I thought just might be related / useful for people looking at this for the first time. I have rust and zephyr rtos experience and outside of looking at issues, was wondering what other planning infrastructure exists (message boards, chat / irc, etc)

Activity

d3zd3z

d3zd3z commented on Jul 1, 2025

@d3zd3z
Collaborator

I suspect some of this comes from much of the initial development coming from people that have already been involved in Zephyr, and are bringing Rust interest.

The top level https://zephyrproject.org/ page does have a link to the community Discord. There is a #rust channel there where most discussions happen.

But, ideas to improve the documentation are certainly welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @d3zd3z@kamathba

        Issue actions

          Add testing / contributing / roadmap information to readme · Issue #84 · zephyrproject-rtos/zephyr-lang-rust