From 88437e9d63db9a901ef492d32acbf97c724afcf0 Mon Sep 17 00:00:00 2001 From: Rage OxR463 <43783393+oxr463@users.noreply.github.com> Date: Tue, 12 Feb 2019 20:20:01 -0500 Subject: [PATCH] Add contributing guide Update howto-release.txt Create ISSUE_TEMPLATE Bugs: https://github.com/proot-me/PRoot/issues/157 --- HACKING.rst | 41 +++++++++++++++++++++++++++++++++++++++++ ISSUE_TEMPLATE | 27 +++++++++++++++++++++++++++ doc/howto-release.txt | 2 +- 3 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 HACKING.rst create mode 100644 ISSUE_TEMPLATE diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 0000000..77939b0 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,41 @@ +============================== + Contributing to PRoot / CARE +============================== + +----------------------------------------------------------- +An introduction to contributing to PRoot / CARE development +----------------------------------------------------------- + +The PRoot Team welcomes, and depends, on contributions from students and +collaborators in the open source and academic communities. +Contributions can be made in a number of ways, a few examples are: + +- Code patches via pull requests +- Documentation improvements +- Bug reports and patch reviews + +Reporting an Issue +================== + +Please include as much detail as you can. Let us know your host kernel +version, e.g, :code:`uname -a`, host/guest distribution, e.g. :code:`cat /etc/os-release`, +and the :code:`PRoot`/:code:`CARE` version number. If you get an error please include the full +error and/or traceback. Issues are tracked on GitHub at , +or can also be sent via the `mailing list `_. + +Submitting Pull Requests +======================== + +Once you are happy with your changes or you are ready for some feedback, push +it to your fork and send a pull request. For a change to be accepted it will +most likely need to have updated tests and/or documentation. New features +**require** additional tests in order to be included in a future release. + +Resources +========= + +- `Contributing to Open Source Projects `_ + +- `How To Ask Questions The Smart Way `_ + +- `Indentation Style - Wikipedia `_ diff --git a/ISSUE_TEMPLATE b/ISSUE_TEMPLATE new file mode 100644 index 0000000..21727de --- /dev/null +++ b/ISSUE_TEMPLATE @@ -0,0 +1,27 @@ +## Expected Behavior + +## Actual Behavior + + +## Steps to Reproduce the Problem + + 1. + 2. + 3. + +## Specifications + + - Proot/Care version: + - Kernel version: + - Host distribution: + - Guest distribution: + +## Command Output + +```terminal +Inline log +``` + +-OR- + +[Attached log]() diff --git a/doc/howto-release.txt b/doc/howto-release.txt index eeb6104..bc92e07 100644 --- a/doc/howto-release.txt +++ b/doc/howto-release.txt @@ -26,7 +26,7 @@ Checks where "/usr/bin/true" is a symlink to "/bin/true". -+ Static analysis: Coverity Scan and Clang Scan Build must not report ++ Static analysis: Gcov/Lcov and Clang Scan Build must not report new issues.