andreas/mac_os
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated contributing documentation.

Browse Source 
- Simplified the documentation to be more succinct in what is required
  (especially in terms of the Style Guides and GitHub pull request and
  issue template).

[ci skip]
This commit is contained in:
Brooke Kuhlmann
2017-02-05 11:26:54 -07:00
parent 3a896882c9
commit a2a2820098
1 changed files with 10 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@@ -1,33 +1,25 @@
# 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.
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
- 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/ruby.md).
Read through the [Programming Style
Guides](https://github.com/bkuhlmann/style_guides/tree/master/programming).
# Contributing Code
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.
0. Read the project README before starting.
0. Fork the `master` branch of the repository.
0. Ensure there are no setup, usage, and/or test issues (see README for details).
0. Add tests for new functionality and ensure they pass.
0. Submit a pull request and follow the instructions it provides.
# Submitting Issues
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.
0. Follow the instructions provided within the GitHub issue template.
# Feedback