Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section about development best practices to CONTRIBUTING #1337

Merged
merged 4 commits into from
Jun 6, 2024
Merged

Add section about development best practices to CONTRIBUTING #1337

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e1c3a70
Add section about development best practices to CONTRIBUTING
kestarumper May 14, 2024
60eb47f
Update .github/CONTRIBUTING.md
kestarumper May 27, 2024
13c4fcd
Refactor
kestarumper May 27, 2024
fbda54b
Merge branch 'master' into contributing-development
kestarumper May 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's better!


In the root directory...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds a little strange. Maybe reword this to a direct command like "Run the commands below in the root directory."


#### Running the build in watch mode

```sh
npm run build -- --watch
```

#### Running the tests in watch mode

```sh
npm run test -- --watch
```

kestarumper marked this conversation as resolved.
Show resolved Hide resolved
#### Making changes to the documentation website (docusaurus)

The local version of docs will use the locally built version of uniforms, so make sure to run the build in watch mode for live changes.

Navigate to `/website` and run

```sh
npm start
```

it will start the docusaurus in development mode supporting hot reload, so you should see the changes made to the website immediately.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this sentence should be capitalized. Also not sure if you need the comma after "hot reload"


## _Work in progress_ PRs are also welcome

If you can't or won't finish your PR, submit it anyway - maybe someone else will continue your work. If you don't know how to achieve your desired feature - file an issue for it - maybe someone else will implement it.
Loading