-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
09084f9
commit 7c4e1db
Showing
2 changed files
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Contributing | ||
|
||
Harper is completely open to outside contributors of any kind. | ||
|
||
If you have a feature request or bug to report, please [create an issue](https://github.com/elijah-potter/harper/issues). | ||
|
||
## Committing | ||
|
||
Harper follows [conventional commit practices](https://www.conventionalcommits.org/en/v1.0.0/). | ||
Before creating a pull request, please make sure all your commits follow the linked conventions. | ||
|
||
Additionally, to minimize the labor required to review your commit, we run a relatively strict suite of formatting and linting programs. | ||
We highly recommend that you run both `format.sh` and `precommit.sh` before submitting a pull request. | ||
If those scripts don't work in your environment, we run `precommit.sh` through GitHub actions inside of pull requests, so you may make modifications and push until the checks pass. | ||
|
||
If this sounds intimidating, don't worry. | ||
We are entirely willing to work with you to make sure your code can make it into Harper, just know it might take a little longer. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters