-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #55 from Doist/tartandsandal/document-and-cleanup
chore: cleanup and document contributing and publishing
- Loading branch information
Showing
7 changed files
with
54 additions
and
169 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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 | ||
|
||
Thanks for helping us make Bitmapist work better. | ||
|
||
Please feel free to [report any issue](https://github.com/Doist/bitmapist/issues/new/choose) you may have. | ||
|
||
**Working on your first Pull Request?** You can learn how from this _free_ | ||
series [How to Contribute to an Open Source Project on GitHub][egghead] | ||
|
||
If you want to contribute with code, please open a Pull Request. A few things to keep in mind: | ||
|
||
- The BSD project is released under the [BSD license](./LICENSE) | ||
- Please use [pre-commit](https://pre-commit.com/) to ensure some formatting rules and basic consistency checks are applied before each Git commit | ||
- Please add tests for your changes! | ||
- Please document any changes using the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention | ||
- Changes in a PR should be documented under an `[Unreleased]` version | ||
- We'll bump the version number and update the changelog in a separate PR when publishing |
This file was deleted.
Oops, something went wrong.
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
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