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

docs: explanation on how to deal with tests failing on windows #575

Merged
merged 6 commits into from
Jun 14, 2023
Merged

docs: explanation on how to deal with tests failing on windows #575

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
45a3849
Update README.md
Ruchip16 Aug 1, 2022
9483f58
Update README.md
Ruchip16 Aug 17, 2022
cbc0374
Merge branch 'master' into master
Ruchip16 Nov 10, 2022
0cedd7c
Update README.md
Ruchip16 Nov 10, 2022
dce731c
Merge branch 'master' into master
magicmatatjahu Dec 20, 2022
cec70f0
Merge branch 'master' into master
jonaslagoni Jun 14, 2023
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
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,6 @@ const oldAsyncAPIDocument = convertToOldAPI(document);
## Notes

### Using with Webpack

Versions `<5` of Webpack should handle bundling without problems. Due to the fact that Webpack 5 no longer does fallbacks to native NodeJS modules by default we need to install `buffer` package and add fallbacks:

```js
Expand Down Expand Up @@ -431,8 +430,16 @@ moduleNameMapper: {
1. Make sure you are using Node.js 16 or higher and npm 8 or higher
2. Write code and tests.
3. Make sure all tests pass `npm test`

For Windows environments, some tests might still fail randomly during local development even when you made no changes to the tests. The reason for this from file endings are different than expected and this comes from Git defaulting to an unexpected file ending. If you encounter this issue you can run the following commands to set Git to use the expected one:
```
git config --global core.autocrlf false
git config --global core.eol lf
```

4. Make sure code is well formatted and secure `npm run lint`


## Contributing

Read [CONTRIBUTING](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md) guide.
Expand Down