From a9b17a112d10eecea6bb9f90705a2a4319fddc9d Mon Sep 17 00:00:00 2001 From: Johny Ho Date: Wed, 28 Jun 2023 20:32:49 -0400 Subject: [PATCH] Add a contributing document https://github.com/thoughtbot/props_template/issues/3 --- CONTRIBUTING.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ec48b5d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ +# Contributing to PropsTemplate + +We love pull requests from everyone. By participating in this project, you +agree to abide by the thoughtbot [code of conduct]. + +[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct + +Here are some ways *you* can contribute: + +* by using alpha, beta, and prerelease versions +* by reporting bugs +* by suggesting new features +* by writing or editing documentation +* by writing specifications +* by writing code ( **no patch is too small** : fix typos, add comments, etc. ) +* by refactoring code +* by closing [issues][] +* by reviewing patches + +[issues]: https://github.com/thoughtbot/props_template/issues + +## Submitting an Issue + +* We use the [GitHub issue tracker][issues] to track bugs and features. +* Before submitting a bug report or feature request, check to make sure it hasn't + already been submitted. +* When submitting a bug report, please include a reproduction script and any + other details that may be necessary to reproduce the bug, including your gem + version, Ruby version, and operating system. + +## Cleaning up issues + +* Issues that have no response from the submitter will be closed after 30 days. +* Issues will be closed once they're assumed to be fixed or answered. If the + maintainer is wrong, it can be opened again. +* If your issue is closed by mistake, please understand and explain the issue. + We will happily reopen the issue. + +## Submitting a Pull Request + +1. [Fork][fork] the [official repository][repo]. +1. [Create a topic branch.][branch] +1. Implement your feature or bug fix. +1. Add, commit, and push your changes. +1. [Submit a pull request.][pr] + +### Notes + +* Please add tests if you changed code. Contributions without tests won't be accepted. +* If you don't know how to add tests, please put in a PR and leave a comment + asking for help. We love helping! +* Please don't update the Gem version. + +## Setting up + +You can use the development `Gemfile` by + +```sh +bundle install +``` + +## Running the test suite + +```sh +bundle exec rspec +``` + +To run an individual rspec test, you can provide a path and line number: + +```sh +bundle exec rspec spec/path/to/spec.rb:123 +``` + +## Formatting + +Use [standard] to automatically format your code: + +```sh +bundle exec rake standard:fix +``` + +[repo]: https://github.com/thoughtbot/props_template/tree/main +[fork]: https://help.github.com/articles/fork-a-repo/ +[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/ +[pr]: https://help.github.com/articles/using-pull-requests/ +[standard]: https://github.com/testdouble/standard + +Inspired by https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md