diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..dec8ed31 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,24 @@ +**Hello, and welcome to the mRemoteNG project!** + +Open source software is best when shared with others. This also applies to the work that goes into the software. Your ideas and passion are what make this software great! +There are many ways that you can help improve mRemoteNG, even if you don't know how to program: + +- add documentation or "how-to" articles on the Wiki +- answer support questions on the forum +- add or improve a translation +- submit a pull request for a bug or feature ticket + +The GitHub Issue tracker is our preferred channel for bug reports and feature requests. +For questions or general discussion, please use [our public Gitter chat](https://gitter.im/mRemoteNG/PublicChat) or the [forum](http://forum.mremoteng.org). + +If you find a security vulnerability, do **NOT** open an issue. Email security@mremoteng.org instead. + +You'll find all information on our GitHub workflow in our [Wiki](https://github.com/mRemoteNG/mRemoteNG/wiki), or you can use these links: + +- [Branches](https://github.com/mRemoteNG/mRemoteNG/wiki/Branches) +- [Bug Repots](https://github.com/mRemoteNG/mRemoteNG/wiki/Bug-Reports) +- [Feauture Requests](https://github.com/mRemoteNG/mRemoteNG/wiki/Feature-Requests) +- [Pull Requests](https://github.com/mRemoteNG/mRemoteNG/wiki/Pull-Requests) + +Want to help but don't know where to start? Check out the issues that we've labeled with [`Help Wanted`](https://github.com/mRemoteNG/mRemoteNG/issues?q=is%3Aissue+is%3Aopen+label%3A%22Help+Wanted%22) or [`ready`](https://github.com/mRemoteNG/mRemoteNG/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22ready%22). These will vary in difficulty, but should be possible for new contributors. +Even if you don't know C# you can heck out the issues that we've labeled with [`Documentation`](https://github.com/mRemoteNG/mRemoteNG/labels/Documentation). diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..53cb42df --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,30 @@ + + +## Expected Behavior + + + +## Current Behavior + + + +## Possible Solution + + + +## Steps to Reproduce (for bugs) + + +1. +2. +3. +4. + +## Context + + + +## Your Environment + +* Version used: +* Operating System and version (e.g. Windows 10 1709 x64): diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..225845bc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,31 @@ + + +## Description + + +## Motivation and Context + + + +## How Has This Been Tested? + + + + +## Screenshots (if appropriate): + +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + + +- [ ] I have read the **CONTRIBUTING** document. +- [ ] My code follows the code style of this project. +- [ ] This pull request does not target the master branch. +- [ ] I have updated the changelog file accordingly. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly.