a2a2820098
- 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]
28 lines
956 B
Markdown
28 lines
956 B
Markdown
# 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.
|
|
|
|
# Requirements
|
|
|
|
Read through the [Programming Style
|
|
Guides](https://github.com/bkuhlmann/style_guides/tree/master/programming).
|
|
|
|
# Contributing 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. 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. Follow the instructions provided within the GitHub issue template.
|
|
|
|
# Feedback
|
|
|
|
Expect a response within one to three business days.
|
|
Changes, alternatives, and/or improvements might be suggested upon review.
|