Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: capricorn86/happy-dom
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v10.0.6
Choose a base ref
...
head repository: capricorn86/happy-dom
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v10.0.7
Choose a head ref
  • 2 commits
  • 1 file changed
  • 1 contributor

Commits on Jul 10, 2023

  1. #972@trivial: Update contributing documentation.

    @capricorn86
    capricorn86 committed Jul 10, 2023
    Copy the full SHA
    823e486 View commit details

  2. Merge pull request #973 from capricorn86/task/972-improve-contributio… 

    …n-documentation

#972@trivial: Update contributing documentation.
    @capricorn86
    capricorn86 authored Jul 10, 2023
    Copy the full SHA
    34fceb1 View commit details
Showing with 9 additions and 1 deletion.
  1. +9 −1 docs/contributing.md
10 changes: 9 additions & 1 deletion docs/contributing.md
View file
Original file line number Diff line number Diff line change
@@ -6,8 +6,10 @@ We are very happy that you would like to contribute. In this guide you will find

### Install

We need to add "--legacy-peer-deps" to the install as a workaround to be able to install Vitest. Otherwise we get an "Cannot set properties of null (setting 'parent')" error as Vitest has "happy-dom" as peer dependency. Hopefully we can find a better solution in the future.

```bash
npm install
npm install --legacy-peer-deps
```

### Compile
@@ -73,6 +75,12 @@ The release process in Happy DOM is completely automated. In order to determine
| minor | New features that doesn't break anything for the end user should have this version type. |
| major | Breaking changes should use this version type. |

### Rebasing

The commit convention can cause problems when editing a message when rebasing. You can then set the setting "core.commentChar" to "auto" to workaround the problem.

We should consider moving over to Conventional Commit as it is more of a standard and doesn't have this problem.

# Pull Request

Do your changes on a branch. When you are done with your changes you can create a pull request.