diff options
| author | Vincent Ambo <mail@tazj.in> | 2018-10-05T22·31+0200 |
|---|---|---|
| committer | Vincent Ambo <github@tazj.in> | 2018-10-05T22·51+0200 |
| commit | 55c4943df14a73acce102f105e096f3a3978faab (patch) | |
| tree | ff9b097e72b49f2c26a4ff46b65d37a2e62deae2 /CONTRIBUTING.md | |
| parent | 86c25cc2264b67678b39046b74932e9237b03bf7 (diff) | |
docs(README): Add notes about error reporting & minor improvements
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae492ef2da..a001f97776 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,7 +74,7 @@ different commit. Introducing a new feature and refactoring `git commit -a` is generally **taboo**. -In our experience making "sane" commits becomes *significantly* easier +In my experience making "sane" commits becomes *significantly* easier as developer tooling is improved. The interface to `git` that I recommend is [magit][]. Even if you are not yet an Emacs user, it makes sense to install Emacs just to be able to use magit - it is @@ -91,16 +91,16 @@ very subjective, but as an example if you place code that throws away errors into a block in which errors are handled properly your change will be rejected. -In our experience there is a strong correlation between the visual +In my experience there is a strong correlation between the visual appearance of a code block and its quality. This is a simple way to sanity-check your work while squinting and keeping some distance from your screen ;-) ## Builds & tests -Most of our projects are built using [Nix][] to avoid "build -pollution" via the user's environment. If you have Nix installed and -are contributing to a project that has a `default.nix`, consider using +Most of my projects are built using [Nix][] to avoid "build pollution" +via the user's environment. If you have Nix installed and are +contributing to a project that has a `default.nix`, consider using `nix-build` to verify that builds work correctly. If the project has tests, check that they still work before submitting |