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

Initial rfc for code standards #4

Merged
merged 23 commits into from
May 25, 2021
Merged

Initial rfc for code standards #4

merged 23 commits into from
May 25, 2021

Conversation

Voxelot
Copy link
Member

@Voxelot Voxelot commented May 19, 2021

This PR includes a RFC describing the process for submitting future coding standard RFCs.

It also includes the following changes:

  • New build script for mdbook (borrowed from Rust RFCs) to enable autogeneration of the summary so that it is always up-to-date with any rfcs added to the /text/ folder.
  • Code Standards section of the book. If any RFCS are made to change the coding standards, that PR should also directly update the appropriate sections in the code-standards book to reflect the RFC outcome.
  • Some very rudimentary initial code standards around linting, security audits, semver, api design guidelines and logging.

@Voxelot Voxelot marked this pull request as ready for review May 20, 2021 06:42
Copy link

@vlopes11 vlopes11 left a comment

Choose a reason for hiding this comment

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

Small nit

@vlopes11
Copy link

Suggestion: include #![warn(missing_docs)] as mandatory for all crates.

Considering warning are blockers for the CI, then this should make at least some basic documentation mandatory

@Voxelot Voxelot merged commit 7dfae98 into master May 25, 2021
@Voxelot Voxelot deleted the rfc-code-standards branch May 25, 2021 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants