Skip to content

Commit

Permalink
chore: update github guides
Browse files Browse the repository at this point in the history
  • Loading branch information
arthur-er committed Aug 30, 2023
1 parent 9323390 commit e1bb836
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,24 @@ We love pull requests. And following this guidelines will make your pull request

- Install [EditorConfig](http://editorconfig.org/) plugin for your code editor to make sure it uses correct settings.
- Fork the repository and clone your fork.
- Install dependencies: `npm install`.
- Install dependencies: `pnpm install`.

## Coding style

We make use of [standard](https://standardjs.com/) to lint our code. Standard does not need a config file and comes with set of non-configurable rules.
We make use of [eslint](https://eslint.org/) to lint our code.

## Development work-flow

Always make sure to lint and test your code before pushing it to the GitHub.

```bash
npm test
pnpm test
```

Just lint the code

```bash
npm run lint
pnpm lint
```

**Make sure you add sufficient tests for the change**.
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ _Put an `x` in the boxes that apply_

_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._

- [ ] I have read the [CONTRIBUTING](https://github.com/verful/permissions/blob/master/.github/CONTRIBUTING.md) doc
- [ ] I have read the [CONTRIBUTING](https://github.com/verful/adonis-permissions/blob/master/.github/CONTRIBUTING.md) doc
- [ ] Lint and unit tests pass locally with my changes
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] I have added necessary documentation (if appropriate)
Expand Down

0 comments on commit e1bb836

Please sign in to comment.