From 9cf9daca31d7a70e565d6e213fdbbb9d571fd58e Mon Sep 17 00:00:00 2001 From: "Daniel S. Billing" Date: Fri, 8 Jan 2021 22:55:43 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..73d59f90d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features +- Becoming a contributor + +## We Develop with Github +We use github to host code, to track issues and feature requests, as well as accept pull requests. + +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: + +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, test it. +3. Ensure your commits has descriptive text. +4. Issue that pull request! + +## Any contributions you make will be under the GNU GPLv3 License +In short, when you submit code changes, your submissions are understood to be under the same [GNU GPLv3 license](http://choosealicense.com/licenses/gpl-3.0/) that covers the project. + +## Reporting bugs +We use GitHub [issues](https://github.com/P3D-Legacy/P3D-Legacy/issues) to track public bugs. Report a bug by opening a new issue; it's that easy! Write bug reports with detail, this makes it a lot easier to understand the issue. + +**Great Bug Reports** tend to have: + +- A quick summary and/or background +- Steps to reproduce. Be specific! +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)