lib/gemsmith/templates/%gem_name%/CONTRIBUTING.md.tt in gemsmith-3.1.0 vs lib/gemsmith/templates/%gem_name%/CONTRIBUTING.md.tt in gemsmith-3.2.0
- old
+ new
@@ -1,46 +1,35 @@
# Overview
-Thanks for taking an interest in this open source project. Your support
-and involvement is greatly appreciated. The following details what you need to know
-in order to contribute back.
+Thanks for taking an interest in this open source project. Your support and involvement is greatly appreciated. The
+following details what you need to know in order to contribute.
# Requirements
-* Document the code - Explain the intent/purpose along with usage examples (where appropriate).
-* Write tests that demonstration passing and failing requirements.
-* Use two spaces, no tabs for indentation.
-* Remove trailing whitespace.
-* Remove spaces from blank lines.
-* Write methods as "example_method example_params", not "example_method(example_params)" for one-liners.
-* Write methods as "outer_method inner_method(example_params)" for nested method calls.
-* Use &&/|| instead of and/or where appropriate.
-* Define a = b instead of a=b.
-* In the end, follow the conventions found in the source code.
-* Use common sense, keep it simple.
+* Follow these [Basic Programming Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/basic.md).
+* Follow these [Code Review Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/code_reviews.md).
+* Follow these [Git Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/git.md).
+* Follow these [Bash Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/bash.md).
+* Follow these [CSS Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/css.md).
+* Follow these [Ruby Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/ruby.md).
-# Contributing Code (awesome option)
+# Contributing Code
-1. Fork the repository (master branch).
-2. Ensure there are no setup issues (see README for details).
-3. Run the tests (see README for details).
-4. Add tests for new functionality (refactoring and documentation changes can be excluded).
-5. Ensure all tests pass.
-6. Push your fork and submit a pull request.
+0. Read the project README thoroughly before starting.
+0. Fork the master branch of the repository.
+0. Ensure there are no setup, usage, and/or test issues (again, follow the README).
+0. Add tests for new functionality (refactoring and documentation changes can be excluded).
+0. Ensure all tests pass.
+0. Push your feature branch and submit a pull request.
-# Contributing Issues (lazy, but sometimes necessary, option)
+# Submitting Issues
-1. Submit an issue via the GitHub Issues tab (assuming one does not already exist).
-2. Clearly describe the issue (including steps to reproduce).
-3. Specify your enviroment setup (OS, browser, language, etc. with version info).
-4. Provide a stack dump (if possible).
-5. Explain any additional details that might help diagnose the problem quickly.
+0. Submit an issue via the GitHub Issues tab (assuming one does not already exist).
+0. Clearly describe the issue (including steps to reproduce).
+0. Specify your enviroment setup (OS, browser, language, etc. with version info).
+0. Provide a stack dump (if possible).
+0. Explain any additional details that might help diagnose the problem quickly.
# Feedback
Expect a response with one to three business days (normally responses are faster than mentioned).
Changes, alternatives, and/or improvements might be suggested upon review.
-
-# Resources
-
-* [GitHub Documentation](http://help.github.com)
-* [GitHub Pull Request Documentation](http://help.github.com/send-pull-requests)