aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKjeld Schouten-Lebbing <[email protected]>2020-09-23 18:53:26 +0200
committerGitHub <[email protected]>2020-09-23 09:53:26 -0700
commiteb267f08cf52fb5f31c6c671bfc0f2cfbf6d0c06 (patch)
tree1a20bf1596c43c34b1456a2e33c362805a252c48
parent20dfe8cd3b63773f0c50a5c611300843c28ef6ae (diff)
Update issue templates, commitcheck and Contributing.md
- Removes OpenZFS ports from commit check - Removes OpenZFS ports from CONTRIBUTING.md - Adds mailings lists and IRC to issue template selector - Remove blank issue option from issue creator Reviewed-by: George Melikov <[email protected]> Reviewed-by: Brian Behlendorf <[email protected]> Co-authored-by: George Melikov <[email protected]> Signed-off-by: Kjeld Schouten-Lebbing <[email protected]> Closes #10965
-rw-r--r--.github/CONTRIBUTING.md68
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml11
-rwxr-xr-xscripts/commitcheck.sh59
3 files changed, 13 insertions, 125 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 5b3e7fa2a..4e2c8901d 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -126,8 +126,8 @@ feature needed? What problem does it solve?
#### General
-* All pull requests must be based on the current master branch and apply
-without conflicts.
+* All pull requests, except backports and releases, must be based on the current master branch
+and should apply without conflicts.
* Please attempt to limit pull requests to a single commit which resolves
one specific issue.
* Make sure your commit messages are in the correct format. See the
@@ -215,70 +215,6 @@ attempting to solve.
Signed-off-by: Contributor <[email protected]>
```
-#### OpenZFS Patch Ports
-If you are porting OpenZFS patches, the commit message must meet
-the following guidelines:
-* The first line must be the summary line from the most important OpenZFS commit being ported.
-It must begin with `OpenZFS dddd, dddd - ` where `dddd` are OpenZFS issue numbers.
-* Provides a `Authored by:` line to attribute each patch for each original author.
-* Provides the `Reviewed by:` and `Approved by:` lines from each original
-OpenZFS commit.
-* Provides a `Ported-by:` line with the developer's name followed by
-their email for each OpenZFS commit.
-* Provides a `OpenZFS-issue:` line with link for each original illumos
-issue.
-* Provides a `OpenZFS-commit:` line with link for each original OpenZFS commit.
-* If necessary, provide some porting notes to describe any deviations from
-the original OpenZFS commits.
-
-An example OpenZFS patch port commit message for a single patch is provided
-below.
-```
-OpenZFS 1234 - Summary from the original OpenZFS commit
-
-Authored by: Original Author <[email protected]>
-Reviewed by: Reviewer One <[email protected]>
-Reviewed by: Reviewer Two <[email protected]>
-Approved by: Approver One <[email protected]>
-Ported-by: ZFS Contributor <[email protected]>
-
-Provide some porting notes here if necessary.
-
-OpenZFS-issue: https://www.illumos.org/issues/1234
-OpenZFS-commit: https://github.com/openzfs/openzfs/commit/abcd1234
-```
-
-If necessary, multiple OpenZFS patches can be combined in a single port.
-This is useful when you are porting a new patch and its subsequent bug
-fixes. An example commit message is provided below.
-```
-OpenZFS 1234, 5678 - Summary of most important OpenZFS commit
-
-1234 Summary from original OpenZFS commit for 1234
-
-Authored by: Original Author <[email protected]>
-Reviewed by: Reviewer Two <[email protected]>
-Approved by: Approver One <[email protected]>
-Ported-by: ZFS Contributor <[email protected]>
-
-Provide some porting notes here for 1234 if necessary.
-
-OpenZFS-issue: https://www.illumos.org/issues/1234
-OpenZFS-commit: https://github.com/openzfs/openzfs/commit/abcd1234
-
-5678 Summary from original OpenZFS commit for 5678
-
-Authored by: Original Author2 <[email protected]>
-Reviewed by: Reviewer One <[email protected]>
-Approved by: Approver Two <[email protected]>
-Ported-by: ZFS Contributor <[email protected]>
-
-Provide some porting notes here for 5678 if necessary.
-
-OpenZFS-issue: https://www.illumos.org/issues/5678
-OpenZFS-commit: https://github.com/openzfs/openzfs/commit/efgh5678
-```
-
#### Coverity Defect Fixes
If you are submitting a fix to a
[Coverity defect](https://scan.coverity.com/projects/zfsonlinux-zfs),
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..70af366c4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+ - name: OpenZFS Community Support Mailing list (Linux)
+ url: https://zfsonlinux.topicbox.com/groups/zfs-discuss
+ about: Get community support for OpenZFS on Linux
+ - name: FreeBSD Community Support Mailing list
+ url: https://lists.freebsd.org/mailman/listinfo/freebsd-fs
+ about: Get community support for OpenZFS on FreeBSD
+ - name: OpenZFS on IRC
+ url: https://webchat.freenode.net/#openzfs
+ about: Use IRC to get community support for OpenZFS
diff --git a/scripts/commitcheck.sh b/scripts/commitcheck.sh
index c7515c23e..1fe29da9b 100755
--- a/scripts/commitcheck.sh
+++ b/scripts/commitcheck.sh
@@ -89,56 +89,6 @@ function new_change_commit()
return $error
}
-function is_openzfs_port()
-{
- # subject starts with OpenZFS means it's an openzfs port
- subject=$(git log -n 1 --pretty=%s "$REF" | grep -E -m 1 '^OpenZFS')
- if [ -n "$subject" ]; then
- return 0
- fi
-
- return 1
-}
-
-function openzfs_port_commit()
-{
- error=0
-
- # subject starts with OpenZFS dddd
- subject=$(git log -n 1 --pretty=%s "$REF" | grep -E -m 1 '^OpenZFS [[:digit:]]+(, [[:digit:]]+)* - ')
- if [ -z "$subject" ]; then
- echo "error: OpenZFS patch ports must have a subject line that starts with \"OpenZFS dddd - \""
- error=1
- fi
-
- # need an authored by line
- if ! check_tagged_line "Authored by" ; then
- error=1
- fi
-
- # need a reviewed by line
- if ! check_tagged_line "Reviewed by" ; then
- error=1
- fi
-
- # need ported by line
- if ! check_tagged_line "Ported-by" ; then
- error=1
- fi
-
- # need a url to openzfs commit and it should be valid
- if ! check_tagged_line_with_url "OpenZFS-commit" ; then
- error=1
- fi
-
- # need a url to illumos issue and it should be valid
- if ! check_tagged_line_with_url "OpenZFS-issue" ; then
- error=1
- fi
-
- return $error
-}
-
function is_coverity_fix()
{
# subject starts with Fix coverity defects means it's a coverity fix
@@ -192,15 +142,6 @@ if [ -n "$1" ]; then
REF="$1"
fi
-# if openzfs port, test against that
-if is_openzfs_port; then
- if ! openzfs_port_commit ; then
- exit 1
- else
- exit 0
- fi
-fi
-
# if coverity fix, test against that
if is_coverity_fix; then
if ! coverity_fix_commit; then