diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08310310..086a5103 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,53 +1,53 @@ -# Contributing to `relude` +# Contributing to the Kowainik repositories ## :wave: Greetings Traveler! -We're glad you're reading this, we really appreciate the effort you're -putting in. Thank you for your help in making this library awesome! :sparkles: +We are delighted you're reading this, and we appreciate the effort you're +taking to make our projects awesome! :sparkles: -### How to contribute +## How to contribute -#### Report bugs or feature request +### :bug: Report bugs or feature request :bulb: -If you have found any bugs or have proposals on how to make this project better, -don't hesitate to create issues -[here](https://github.com/kowainik/relude/issues/new) in free format. +If you discover a bug or have any proposals on how to make this project better +don't hesitate to create an issue [here](../../issues/new) in a free format. -#### Create a PR +### Create a PR -We love receiving pull requests from everyone. But, please, don't create a PR -without a corresponding issue. It's always better to discuss your future -work first. Even if such an issue exists it's still better to express your willing -to do that issue under comment section. Thus you will show that you're doing -that issue, and nobody else will accidentally do it in parallel with you. Furthermore, -you also can discuss the best way to implement that issue! +We love to receive pull requests from everyone! It's usually a good idea +to tell about your intention to work on something under the corresponding +issue, so everyone is aware that you're on it. If there's no such issue — simply +create a new one! -To get started with this you should first fork, then clone the repo: +To get started with the Pull Request implementation you should first +[fork](../../fork), then clone the repo: - git clone git@github.com:your-username/relude.git + git clone git@github.com:your-username/project-name.git -Make your changes and consider the following check list to go through before submitting your pull request. +Make your changes and consider the following checklist to go through +before submitting your pull request. -#### :white_check_mark: Check list +### :white_check_mark: Check list +- [ ] New/fixed features work as expected (Bonus points for the new tests). +- [ ] There are no warnings during compilation. +- [ ] `hlint .` output is: _No Hints_ (see [`hlint`][hlint] tool docs). +- [ ] The code is formatted with the [`stylish-haskell`][stylish-tool] tool + using [stylish-haskell.yaml][stylish] file in the repository. +- [ ] The code style of the files you changed is preserved (for more specific + details on our style guide check [this document][style-guide]). +- [ ] Commit messages are in the proper format. + Start the first line of the commit with the issue number in square parentheses. + + **_Example:_** `[#42] Upgrade upper bounds of 'base'` -- [ ] Project compiles -- [ ] New/fixed features work as expected -- [ ] Old features do not break after the change -- [ ] All new and existing tests pass -- [ ] [`stylish-haskell`](https://github.com/kowainik/org/blob/master/.stylish-haskell.yaml) - with config in this repo root was used to format code -- [ ] _Recommended:_ Commit messages are in the proper format. If the commit - addresses an issue start the first line of the commit with the issue number in - square parentheses. - + **_Example:_** `[#42] Short commit description` -- [ ] All changes are reflected in `.hlint.yaml` (Use `hlint/hlint.dhall` to make changes). +After all above is done commit and push to your fork. +Now you are ready to [submit a pull request](../../compare). -If you fix bugs or add new features, please add tests. - -After everything above is done, commit and push to your fork. -Now you are ready to [submit a pull request][pr]! ---------- -Thanks for spending time on reading this contributing guide! :sparkling_heart: +Thanks for spending your time on reading this contributing guide! :sparkling_heart: -[pr]: https://github.com/kowainik/relude/compare/ +[stylish]: .stylish-haskell.yaml +[stylish-tool]: http://hackage.haskell.org/package/stylish-haskell +[hlint]: http://hackage.haskell.org/package/hlint +[style-guide]: https://github.com/kowainik/org/blob/master/style-guide.md#haskell-style-guide