Skip to content

Commit 5538ffa

Browse files
yaperez-anssihg-anssi
authored andcommitted
add a separate CONTRIBUTING document
1 parent ee5f594 commit 5538ffa

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to This Project
2+
3+
Thank you for your interest in this project. Please read this document
4+
carefully before considering any contributions.
5+
6+
At this time, this guide is intended to be a living document. It still lacks
7+
important points and details, and future versions of the language and compiler
8+
may render some recommendations obsolete. We are eager to discuss and to receive
9+
contributions from anyone who is aware of common or uncommon pitfalls to avoid,
10+
or good coding practices and tools that can help building more robust software
11+
with the Rust language.
12+
13+
Thus, feel free to create pull requests to suggest recommendations or
14+
modifications, or to submit an issue to start discussions. Specifically, please
15+
opt for a *pull request* for small changes like:
16+
17+
- complementing a paragraph,
18+
- adding a small example in the form of code snippet,
19+
- updating some information
20+
- fixing typos and English mistakes,
21+
- etc.
22+
23+
and for an *issue* in case of more substantive changes:
24+
25+
- suggesting a new recommendation,
26+
- discussing controversial points,
27+
- rewording a consistent part of the text,
28+
- etc.

0 commit comments

Comments
 (0)