Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md #61

Merged
merged 1 commit into from
Nov 26, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Loading