From 9612d4a06eb45e8b343e31559f26fa68da4561c4 Mon Sep 17 00:00:00 2001 From: Larry Reid Date: Thu, 4 Jan 2018 15:32:28 -0800 Subject: [PATCH 1/4] Add note to "Contributing". Refer reader to issue about Bootstrap 4 and Rails >= 5.1. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c1404a130..c76081c6f 100644 --- a/README.md +++ b/README.md @@ -582,9 +582,24 @@ http://www.codetriage.com/potenza/bootstrap_form ## Contributing +The release of Bootstrap 4 and Rails 5.1 have implications +for the future direction of `bootstrap_form`. +Don't worry. +We plan to move this gem forward to Bootstrap 4 +and to support Rails 5.1 and beyond. +If you're thinking of contributing to `bootstrap_form`, +please read issue #TBD. +Your comments are welcome. + We love pull requests! Here's a quick guide for contributing: -1. Fork the repo. +1. Make sure no one else is working on the same issue or feature. +Search the issues and pull requests for anything +that looks like the issue or feature you want to address. +If no one else is working on your issue or feature, +carry on with the following steps. + +2. Fork the repo. 2. Install the required dependencies. From a44905f72298460c531e8445746e701ca9d58724 Mon Sep 17 00:00:00 2001 From: Larry Reid Date: Thu, 4 Jan 2018 21:15:49 -0800 Subject: [PATCH 2/4] Add issue number for roadmap discussion. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c76081c6f..ca3639125 100644 --- a/README.md +++ b/README.md @@ -588,7 +588,7 @@ Don't worry. We plan to move this gem forward to Bootstrap 4 and to support Rails 5.1 and beyond. If you're thinking of contributing to `bootstrap_form`, -please read issue #TBD. +please read issue #361. Your comments are welcome. We love pull requests! Here's a quick guide for contributing: From 1f50656dcd955a7ec2253ff678edfc6a6feff979 Mon Sep 17 00:00:00 2001 From: Larry Reid Date: Thu, 4 Jan 2018 21:51:58 -0800 Subject: [PATCH 3/4] Fix link to issue. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ca3639125..6216aa81d 100644 --- a/README.md +++ b/README.md @@ -588,7 +588,7 @@ Don't worry. We plan to move this gem forward to Bootstrap 4 and to support Rails 5.1 and beyond. If you're thinking of contributing to `bootstrap_form`, -please read issue #361. +please read [issue #361](https://github.com/bootstrap-ruby/rails-bootstrap-forms/issues/361). Your comments are welcome. We love pull requests! Here's a quick guide for contributing: From 0d9d336a062d529c783c2e90b9b1365bd1749f0a Mon Sep 17 00:00:00 2001 From: Larry Reid Date: Thu, 4 Jan 2018 22:10:10 -0800 Subject: [PATCH 4/4] Split "Contributing" section to CONTRIBUTING.md. Fix contributing link. Another fix to link. Small fix. --- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 52 ++++-------------------------------------------- 2 files changed, 57 insertions(+), 48 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f8c9dd656 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contributing + +The release of Bootstrap 4 and Rails 5.1 have implications +for the future direction of `bootstrap_form`. +Don't worry. +We plan to move this gem forward to Bootstrap 4 +and to support Rails 5.1 and beyond. +If you're thinking of contributing to `bootstrap_form`, +please read [issue #361](https://github.com/bootstrap-ruby/rails-bootstrap-forms/issues/361). +Your comments are welcome. + +Thanks so much for considering contributing to bootstrap_form! +We love pull requests! + +Here's a quick guide for contributing: + +1. Make sure no one else is working on the same issue or feature. +Search the issues and pull requests for anything +that looks like the issue or feature you want to address. +If no one else is working on your issue or feature, +carry on with the following steps. + +2. Fork the repo. + +2. Install the required dependencies. + +``` +bundle install +bundle exec appraisal install +``` + +3. Run the existing test suite: + +``` +$ bundle exec rake -f test/dummy/Rakefile db:create db:migrate RAILS_ENV=test +$ bundle exec appraisal rake test +``` + +4. Add tests for your change. + +5. Add your changes and make your test(s) pass. Following the conventions you +see used in the source will increase the chance that your pull request is +accepted right away. + +6. Update the README if necessary. + +7. Add a line to the CHANGELOG for your bug fix or feature. + +8. Push to your fork and submit a pull request. + +## Contributors + +Thanks to all the great contributors over the years: https://github.com/bootstrap-ruby/rails-bootstrap-forms/graphs/contributors diff --git a/README.md b/README.md index 6216aa81d..26afb6d58 100644 --- a/README.md +++ b/README.md @@ -582,54 +582,10 @@ http://www.codetriage.com/potenza/bootstrap_form ## Contributing -The release of Bootstrap 4 and Rails 5.1 have implications -for the future direction of `bootstrap_form`. -Don't worry. -We plan to move this gem forward to Bootstrap 4 -and to support Rails 5.1 and beyond. -If you're thinking of contributing to `bootstrap_form`, -please read [issue #361](https://github.com/bootstrap-ruby/rails-bootstrap-forms/issues/361). -Your comments are welcome. - -We love pull requests! Here's a quick guide for contributing: - -1. Make sure no one else is working on the same issue or feature. -Search the issues and pull requests for anything -that looks like the issue or feature you want to address. -If no one else is working on your issue or feature, -carry on with the following steps. - -2. Fork the repo. - -2. Install the required dependencies. - -``` -bundle install -bundle exec appraisal install -``` - -3. Run the existing test suite: - -``` -$ bundle exec rake -f test/dummy/Rakefile db:create db:migrate RAILS_ENV=test -$ bundle exec appraisal rake test -``` - -4. Add tests for your change. - -5. Add your changes and make your test(s) pass. Following the conventions you -see used in the source will increase the chance that your pull request is -accepted right away. - -6. Update the README if necessary. - -7. Add a line to the CHANGELOG for your bug fix or feature. - -8. Push to your fork and submit a pull request. - -## Contributors - -https://github.com/bootstrap-ruby/rails-bootstrap-forms/graphs/contributors +We welcome contributions. +If you're considering contributing to bootstrap_form, +please review the [Contributing](/CONTRIBUTING.md) +document first. ## License