Skip to content

Commit

Permalink
doc: describe rustfmt
Browse files Browse the repository at this point in the history
  • Loading branch information
lklimek committed Nov 7, 2023
1 parent 2b0aa81 commit f5d593b
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ welcome to contribute towards development in the form of peer review, testing
and patches. This document explains the practical process and guidelines for
contributing.


Branches, Bugfixes and New Features
-----------------------------------

Expand All @@ -25,7 +24,6 @@ mailing list discussions).
If a pull request is not (yet) ready to be considered for merging, please set
its status to "Draft" on GitHub.


Conventional Commits
--------------------

Expand All @@ -46,14 +44,19 @@ atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention)
and diffs should be easy to read. For this reason, do not mix any formatting
fixes or code movement with actual code changes.


Code Conventions
----------------

Please ensure that the code you write adheres to the code style adopted in the
project, and that all linting checks are passing. We use [AirBnB
style](https://github.com/airbnb/javascript) for JS code.

For Rust, please format your code using nightly version of rustfmt
and configuration in `.rustfmt.toml`:

```bash
cargo +nightly fmt
```

Testing
-------
Expand All @@ -71,7 +74,6 @@ or e2e tests should be written for larger chunks of functionality (when
appropriate). Unit and integration tests should not make any network calls, and
unit tests should mock all dependencies.


Squashing Commits
-----------------

Expand Down Expand Up @@ -99,7 +101,6 @@ respective change set.
The length of time required for peer review is unpredictable and will vary from
pull request to pull request.


Pull Request Philosophy
-----------------------

Expand All @@ -108,7 +109,6 @@ feature, fix a bug, or refactor code; but not a mixture. Please also avoid super
pull requests which attempt to do too much, are overly large, or overly complex
as this makes review difficult.


"Decision Making" Process
-------------------------

Expand All @@ -128,7 +128,6 @@ In general, all pull requests must:
- Where bugs are fixed, where possible, there should be unit tests demonstrating
the bug and also proving the fix. This helps prevent regression.


Release process
---------------

Expand Down

0 comments on commit f5d593b

Please sign in to comment.