This repository has been archived by the owner on Dec 7, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1516db1
commit 2b75551
Showing
7 changed files
with
35 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# ❓ FAQ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# 🔧 Transparent and tunable |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,25 @@ | ||
# What is this? | ||
# Rustacean Principles | ||
|
||
Rust is... | ||
|
||
* a language empowering everyone to build reliable and efficient software that is meant to last; | ||
* an open-source community focused on creating, designing, and maintaining that language and its ecosystem. | ||
|
||
The **Rustacean principles** are a set of principles which guide us in achieving those goals. | ||
|
||
* The first section, [How Rust ought to feel](./how_rust_feels.md), covers the underlying design principles of Rust. | ||
* The second section, [How to Rustacean](./how_to_rustacean.md), describes the way that Rust team members are expected to act. You can think of it like a companion to the [Code of Conduct][CoC]: whereas the [CoC] describes the bare minimum expected of any Rust participant, the [How to Rustacean] section describes what is takes to become a member of a Rust team. | ||
* The third section, [Case studies](./case_studies.md), walks through various examples of things in Rust and shows how they reflect a balance amongst the design principles. | ||
|
||
## Why develop these principles? | ||
|
||
The goal of these principles is to help us to be more precise as we go about our work in the Rust org. The [How Rust ought to feel](./how_rust_feels.md) section enumerates the kinds of considerations we should consider, and can help us to think more carefully about designs. For example, when we are considering a change, we can talk about whether it works against "it compiles it works" in favor of "empowering", and look for previous case studies that made similar tradeoffs. | ||
|
||
The [How to Rustacean](./how_to_rustacean.md) is similar. We've often had a hard time elaborating on the kinds of behaviors that we are looking for when we select Rust team members. This makes it hard for people to know what they ought to do, but it also makes it very hard for us to communicate where improvement is needed. | ||
|
||
## Is this "official"? | ||
|
||
No -- right now, this is a work-in-progress being developed by nikomatsakis in collaboration with lots of people within the Rust community. When it takes settled shape, it may indeed move to the Rust org as something more official. | ||
|
||
[CoC]: https://www.rust-lang.org/policies/code-of-conduct | ||
[How to Rustacean]: ./how_to_rustacean.md |