Skip to content

Commit

Permalink
chore(docs): update contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushmanchhabra committed Feb 22, 2024
1 parent 391a6e1 commit ca594df
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,11 @@ nwbuild({
### External contributor

- We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) style of commit messages.
- On opening a new PR, the comments will guide you on how to construct the new PR.
- When making changes, try to follow [SOLID](https://en.wikipedia.org/wiki/SOLID) and [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) principles.
- Pull requests are squashed and merged onto the `main` branch.
- PR title is used as commit's first line, PR description is used as commit body.
- Only commit messages starting with `fix`, `feat` and `chore` are recognised by the Release Please bot.
- Lint your code before commiting your change.
- Add tests whenever possible.

Expand Down Expand Up @@ -301,7 +304,6 @@ nwbuild({
### Chores

- chore(cli): migrate from `yargs` to `commander`
- chore(get): investigate [how symlinks are identified](https://github.com/overlookmotel/yauzl-promise/issues/39) and remove the workaround where they are created manually
- chore(get): verify sha checksum for downloads
- chore: annotate file paths as `fs.PathLike` instead of `string`.
- chore(bld): factor out core build step
Expand Down

0 comments on commit ca594df

Please sign in to comment.