Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

book(dev): document the process for adding new workspace crates #273

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ROMemories
Copy link
Collaborator

Not sure the Coding Conventions is the best place to document this, maybe we should have a book section for documenting processes.

@ROMemories ROMemories added the docs Improvements or additions to documentation label Apr 24, 2024
book/src/coding-conventions.md Outdated Show resolved Hide resolved
Co-authored-by: ROMemories <152802150+ROMemories@users.noreply.github.com>
Copy link
Collaborator

@elenaf9 elenaf9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Subjective opinion: not sure if we really need this section, given that we don't add new crates that often
The first couple of points aren't RIOT-rs specific. Only really the points about rexporting the crate from riot-rs and adding it (and potential features flag) to the CI are. Maybe it makes sense to have them, but then I'm in favor of shortening it down.

But not a strong opinion :)

book/src/coding-conventions.md Outdated Show resolved Hide resolved
book/src/coding-conventions.md Outdated Show resolved Hide resolved
book/src/coding-conventions.md Outdated Show resolved Hide resolved
Co-authored-by: Elena Frank <elena.frank@proton.me>
@ROMemories
Copy link
Collaborator Author

Subjective opinion: not sure if we really need this section, given that we don't add new crates that often

I agree it's not a weekly event, but it does happen quite regularly: riot-rs-random was added two weeks ago, and I'm in the process of adding two more (for the sensor abstraction and the built-in sensors).

The first couple of points aren't RIOT-rs specific.

I also agree that not all of it is RIOT-rs-specific, but it helps clarify what tools and configuration we embrace, especially as these are always changing—e.g., inheritance of workspace lints was only added a few months ago and I was personally pleasantly surprised when I saw that using cargo init to add a new workspace crate automatically makes that new crate inherits the workspace lints. It additionally allows us to make explicit some policies that cannot be inferred from the current state of the codebase.
That process is also likely to be relevant to new contributors, as the first step of adding a new piece of functionality may well be to create a new workspace crate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants