Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
coavins committed Nov 26, 2023
1 parent 1f3933c commit bd01bd6
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@ Thank you for your interest in contributing to this project. Everyone is invited

## Testing

We use [luacheck](https://github.com/lunarmodules/luacheck) for linting, just run `luacheck src` in the project root.

Github will automatically run this check on your behalf when submitting a pull request.
We use [luacheck](https://github.com/lunarmodules/luacheck) for linting. GitHub automatically runs this check when you open a pull request.
If you wish, you can lint your changes yourself before pushing by running `luacheck src` in the repository root.

## Creating a Pull Request

Please create a pull request with a clear explanation of what you've done (read more about pull requests [here](http://help.github.com/pull-requests/).)
Please create a pull request targeting the `develop` branch with a clear explanation of what you've done (read more about pull requests [here](http://help.github.com/pull-requests/).)

Each pull request should use a new branch, and it should be based on the `develop` branch. Your branch should be rebased/squashed into as few logical commits as possible.
You should create a new branch for each pull request, and rebase/squash it into as few logical commits as possible.

This repository generally follows the [Chris Beams standards](https://cbea.ms/git-commit/) for commit messages:

Expand Down

0 comments on commit bd01bd6

Please sign in to comment.