Skip to content

Commit 7797b60

Browse files
committed
Add guiding principles to the README
Closes #4
1 parent adb1cbf commit 7797b60

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,33 @@ interested in working on the implementation for an 'active' RFC, but cannot
111111
determine if someone else is already working on it, feel free to ask (e.g. by
112112
leaving a comment on the associated issue).
113113

114+
## Guiding principles
115+
116+
When deciding on style guidelines, discussion should be steered by the following
117+
principles (in priority order):
118+
119+
* readability
120+
- scan-ability
121+
- avoiding misleading formatting
122+
- accessibility - readable and editable by users using the the widest
123+
variety of hardware, including non-visual accessibility interfaces
124+
- readability of code when quoted in rustc error messages
125+
126+
* aesthetics
127+
- sense of 'beauty'
128+
- consistent with other languages/tools
129+
130+
* specifics
131+
- compatibility with version control practices - preserving diffs,
132+
merge-friendliness, etc.
133+
- preventing right-ward drift
134+
- minimising vertical space
135+
136+
* application
137+
- ease of manual application
138+
- ease of implementation (in Rustfmt, and in other tools/editors/code generators)
139+
- internal consistency
140+
- simplicity of formatting rules
141+
142+
To see how these principles were decided, see
143+
[issue 4](https://github.com/rust-lang-nursery/fmt-rfcs/issues/4).

0 commit comments

Comments
 (0)