Skip to content

Latest commit

 

History

History
111 lines (77 loc) · 4.62 KB

CONTRIBUTING.md

File metadata and controls

111 lines (77 loc) · 4.62 KB
Raw

Contributing

Introduction

This book is a catalogue of Rust programming techniques, (anti-)patterns, idioms and other explanations. It is a compilation of collective (sometimes implicit) knowledge as well as experiences that have emerged through collaborative work.

The patterns described here are not rules, but should be taken as guidelines for writing idiomatic code in Rust. We are collecting Rust patterns in this book so people can learn the tradeoffs between Rust idioms and use them properly in their own code.

If you want to be part of this effort here are some ways you can participate:

Discussion board

If you have a question or an idea regarding certain content, but you want to have feedback of fellow community members, and you think it may not be appropriate to file an issue open a discussion in our discussion board.

Writing a new article

Before writing a new article please check in one of the following resources if there is an existing discussion or if someone is already working on that topic:

If you don't find an issue regarding your topic, and you are sure it is not more feasible to open a thread in the discussion board please open a new issue, so we can discuss the ideas and future content of the article together and maybe give some feedback/input on it.

When writing a new article it's recommended to copy the pattern template into the appropriate directory and start editing it. You may not want to fill out every section and remove it, or you might want to add extra sections.

Consider writing your article in a way that has a low barrier of entry so also Rustlings can follow and understand the thought process behind it. So we can encourage people to use these patterns early on.

We encourage you to write idiomatic Rust code that builds in the playground.

If you use links to blogposts or in general content that is not to be sure existing in a few years (e.g. pdfs) please take a snapshot with the Wayback Machine and use the link to that snapshot in your article.

Don't forget to add your new article to the SUMMARY.md to let it be rendered to the book.

Please make Draft Pull requests early, so we can follow your progress and can give early feedback (see the following section).

Style guide

In order to have a consistent style across the book, we suggest to:

  • Follow the official Rust book's style guide.
  • Follow RFC 1574. Tl;dr:
    • Prefer full types name. For example Option<T> instead of Option.
    • Prefer line comments (//) over block comments (/* */) where applicable.

Check the article locally

Before submitting the PR launch the commands mdbook build to make sure that the book builds and mdbook test to make sure that code examples are correct.

Markdown lint

To make sure the files comply with our Markdown style we use markdownlint-cli. To spare you some manual work to get through the CI test you can use the following commands to automatically fix most of the emerging problems when writing Markdown files.

  • Install:

    npm install -g markdownlint-cli

  • Check all markdown files:

    • unix: markdownlint '**/*.md'
    • windows: markdownlint **/*.md

  • Automatically fix basic errors:

    • unix: markdownlint -f '**/*.md'
    • windows: markdownlint -f **/*.md

Creating a Pull Request

"Release early and often!" also applies to pull requests!

Once your article has some visible work, create a [WIP] draft pull request and give it a description of what you did or want to do. Early reviews of the community are not meant as an offense but to give feedback.

A good principle: "Work together, share ideas, teach others."

Important Note

Please don't force push commits in your branch, in order to keep commit history and make it easier for us to see changes between reviews.

Make sure to Allow edits of maintainers (under the text box) in the PR so people can actually collaborate on things or fix smaller issues themselves.