Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
coavins committed Nov 26, 2023
1 parent b997628 commit 2f5c6b1
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# How to contribute

Thank you for your interest in contributing to this project. Everyone is invited to propose changes, fixes, and new features through pull requests in this repository. The following guidelines are intended to enforce good standards and keep the commit history clean and readable.

## Testing

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 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/).)

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:

Separate subject from body with a blank line
Limit the subject line to 50 characters
Capitalize the subject line
Use the imperative mood in the subject line
Do not end the subject line with a period
Use the body to explain what and why vs. how
Wrap the body at 72 characters

Your commits will be expected to meet these standards before your PR will be merged.

0 comments on commit 2f5c6b1

Please sign in to comment.