Updated CONTRIBUTING documentation.
- With code quality tools in place to automate most requirements, the documentation doesn't need to be as verbose. - The documentation has been reduced to the core essentials which means there is less to read and no more links to follow. [ci skip]
This commit is contained in:
@@ -1,27 +1,22 @@
|
||||
# Overview
|
||||
# Contributing
|
||||
|
||||
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.
|
||||
appreciated. The following sections detail what you need to know in order to contribute.
|
||||
|
||||
# Requirements
|
||||
|
||||
Read through the [Programming Style
|
||||
Guides](https://github.com/bkuhlmann/style_guides/tree/master/programming).
|
||||
|
||||
# Contributing Code
|
||||
## Code
|
||||
|
||||
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. Fork the `master` branch of this repository and clone the fork locally.
|
||||
0. Ensure there are no setup, usage, and/or test issues.
|
||||
0. Add tests for new functionality and ensure they pass.
|
||||
0. Submit a pull request and follow the instructions it provides.
|
||||
0. Submit a pull request, follow the instructions it provides, and ensure the build passes.
|
||||
|
||||
# Submitting Issues
|
||||
## Issues
|
||||
|
||||
0. Submit an issue via the GitHub Issues tab (assuming one does not already exist).
|
||||
0. Follow the instructions provided within the GitHub issue template.
|
||||
0. Submit an issue via the GitHub Issues tab (assuming one does not
|
||||
already exist) and follow the instructions it provides.
|
||||
|
||||
# Feedback
|
||||
## Feedback
|
||||
|
||||
Expect a response within one to three business days.
|
||||
Changes, alternatives, and/or improvements might be suggested upon review.
|
||||
- Expect a response within one to three business days.
|
||||
- Changes, alternatives, and/or improvements might be suggested upon review.
|
||||
|
||||
Reference in New Issue
Block a user