From 8a30fc1293f8424ad2327fe7262fdc3ccb3976e0 Mon Sep 17 00:00:00 2001 From: Igor Pecovnik Date: Wed, 20 Jan 2021 16:06:24 +0100 Subject: [PATCH] Update issue and pull request templates --- .github/ISSUE_TEMPLATE.md | 26 -------------------------- .github/ISSUE_TEMPLATE/bug_report.md | 19 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 15 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 25 ++++++++++++++++++------- 4 files changed, 52 insertions(+), 33 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index a049e93e6e..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,26 +0,0 @@ -Please use the "Preview" tab above to view this message if you are seeing this in the new issue text box. - -Please note that this is a **build script** issue tracker. -Issues with provided images should go to the Armbian forum. -Issues with the `armbian-config` application should go to its [repository](https://github.com/armbian/config). -Issues with Device Tree overlays should go to the [dedicated forum thread](https://forum.armbian.com/topic/3787-testers-wanted-sunxi-device-tree-overlays/). - -Please use the Armbian forum (https://forum.armbian.com/) for: - - - reporting boot failures (please read [the documentation](https://docs.armbian.com/User-Guide_Getting-Started/) first!), - - asking for help with Armbian if it is **not** related to building the kernel and/or OS image (please use forum search and Google search first!), - - reporting kernel crashes or similar issues, - - asking for support of new boards or third party hardware (such as wireless and DVB adapters, I2C/SPI sensors, USB touch screens and HDMI displays), - - etc. - -Please use this issue tracker only for the build script related bugs and enhancements, such as: - - - requesting changes to the kernel configuration, - - requesting changes to the default package lists, - - discussing the kernel and/or u-boot patches, - - discussing Armbian specific customizations made at image build time, - - discussing changes and enhancements to the image creation process - -Please note that nightly images and dev kernel branches are provided with minimal support, and only build failures with default (provided) configuration can be considered an issue that needs to be fixed. - -Please remove the text above before opening an issue. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..448898f836 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,19 @@ +--- +name: Build issues +about: Create a new issue if there is something wrong with building Armbian. +title: 'Problem found in ...' +labels: '0.question' +assignees: 'armbian/build-scripts' + +--- + + + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +**Provide logs:** +Drop logs to pastebin service of your choice and supply logs from output/debug diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..1cf69f7e98 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,15 @@ +blank_issues_enabled: false +contact_links: + - name: Bug reporting + url: https://www.armbian.com/bugs/ + about: Use our bug reporting wizzard to file your bug in the correct place + - name: Troubles using Armbian + url: https://forum.armbian.com/forum/23-community-forums/ + about: Support for Linux applications is provided "as is" by community. + - name: Feature Requests + url: https://forum.armbian.com/forum/38-feature-requests/ + about: Feature requests and enhancement ideas. A request does not guarantee consideration. + - name: Jira - our internal bug | issue and project tracking system + url: https://armbian.atlassian.net/ + about: Armbian project management shows you what we are working on but only developers have write access. + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4beed167d1..bca6d1adfd 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,21 @@ -Please use the "Preview" tab above to view this message if you are seeing this in the new pull request text box. +# Description -Please make sure that: +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - - pull request is opened to the `master` branch unless you are working on a specfic feature which is developed in a separate branch - - any changes to kernel configuration files were made by Kconfig menu (build script option `KERNEL_CONFIGURE=yes`) and not by editing configuration files by hand, - - patch file names don't contain spaces and have less than 40 characters (not counting the `.patch` extension), - - changes are properly described - what was done exactly and why. +Jira reference number [AR-9999] -Thanks for contributing! Please remove the text above before opening a pull request. +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Please also note any relevant details for your test configuration. + +- [ ] Test A +- [ ] Test B + +# Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] Any dependent changes have been merged and published in downstream modules