Add section about development best practices to CONTRIBUTING #1337
Conversation
github-actions
bot
added
the
Area: Infra
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1337 +/- ##
=======================================
Coverage 94.37% 94.37%
=======================================
Files 229 229
Lines 3754 3754
Branches 1011 1011
=======================================
Hits 3543 3543
Misses 81 81
Partials 130 130 ☔ View full report in Codecov by Sentry. |
.github/CONTRIBUTING.md
Outdated
| @@ -30,6 +30,36 @@ Our kanban board is public and available [here](https://github.com/orgs/vazco/pr | |||
| - Make sure you have added the necessary tests for your changes. Do not worry though, the Codecov bot will report it in the pull request. | |||
| - Make sure your code passes _all_ tests: `npm test`. | |||
|
|
|||
| ### Development | |||
|
|
|||
| For the best developer experience (DX) when developing locally it is recommended to start `build` and `test` in a `--watch` mode. | |||
There was a problem hiding this comment.
The a is redundant in "a --watch mode". Should either be just "in --watch mode" or "in the --watch mode".
In general you could simplify the start of this sentence but it's subjective so I'm okay with this version too. "For the best local developer experience"
.github/CONTRIBUTING.md
Outdated
|
|
||
| For the best developer experience (DX) when developing locally it is recommended to start `build` and `test` in a `--watch` mode. | ||
|
|
||
| In the root directory... |
There was a problem hiding this comment.
This sounds a little strange. Maybe reword this to a direct command like "Run the commands below in the root directory."
.github/CONTRIBUTING.md
Outdated
| npm start | ||
| ``` | ||
|
|
||
| it will start the docusaurus in development mode supporting hot reload, so you should see the changes made to the website immediately. |
There was a problem hiding this comment.
I think this sentence should be capitalized. Also not sure if you need the comma after "hot reload"
kestarumper
dismissed stale reviews from zendranm, wadamek65, and piotrpospiech
via
d8cb99c
Co-authored-by: Konrad Bosak <konrad.bosak@vazco.eu>
kestarumper
force-pushed
the
contributing-development
branch
from
d8cb99c
to
60eb47f
Compare
This PR adds a section about development best practices and how to achieve better DX when working with this codebase.