This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hop-website.git
The following commit(s) were added to refs/heads/master by this push:
new 17fecac HOP-2324 - add release process information to contribution
page
new 92ddcd4 Merge pull request #14 from bamaer/HOP-2324
17fecac is described below
commit 17fecace125eca2bb02533cdb4381e994d9eafdc
Author: Bart Maertens <[email protected]>
AuthorDate: Sun Dec 20 11:28:37 2020 +0100
HOP-2324 - add release process information to contribution page
---
content/community/contributing.adoc | 3 +-
.../release-contribution-guide.adoc | 83 ++++++++++++++++++++++
2 files changed, 84 insertions(+), 2 deletions(-)
diff --git a/content/community/contributing.adoc
b/content/community/contributing.adoc
index 04db293..4986fb2 100644
--- a/content/community/contributing.adoc
+++ b/content/community/contributing.adoc
@@ -15,8 +15,7 @@ Contributing to Hop goes beyond writing code for the project.
Below, we list dif
Please give detailed information about the problem you encountered and, if
possible, add a description that helps to reproduce the problem. For more
information go to our link:../contribution-guides/jira-guide/[info] page.
|Contribute Code|Read the
link:../contribution-guides/code-contribution-guide/[Code Contribution Guide]
(Work in progress)
|Help With Code Reviews|Read the
link:../contribution-guides/code-review-guide/[Code Review Guide] (Work in
progress)
-|Help Prepare a Release|
-A release candidate will be announced using our form/twitter and chat. We will
then ask as many people as possible to test this candidate and give feedback
before proceeding to an actual release.
+|Help Prepare a Release|Read the
link:../contribution-guides/release-contribution-guide/[Release Review Guide]
(Work in progress)
|Contribute Documentation|Read the
link:../contribution-guides/documentation-contribution-guide/[Documentation
Contribution Guide] (Work in progress)
|Translate Hop|Read the
link:../contribution-guides/translation-contribution-guide/[Translation
Contribution Guide]
|Support Hop Users|
diff --git
a/content/community/contribution-guides/release-contribution-guide.adoc
b/content/community/contribution-guides/release-contribution-guide.adoc
new file mode 100644
index 0000000..72cc1a2
--- /dev/null
+++ b/content/community/contribution-guides/release-contribution-guide.adoc
@@ -0,0 +1,83 @@
+---
+title: "Release Contribution Guide"
+---
+
+Apache releases are created through a formal process. The entire process is
https://www.apache.org/legal/release-policy.html[documented, window=\"_blank\"].
+
+Other useful information:
+
+* https://incubator.apache.org/guides/releasemanagement.html[ASF Release
Management, window=\"_blank\"]
+* https://incubator.apache.org/cookbook/[Apache Incubator Cookbook,
window=\"_blank\"]
+
+Check below for the TL;DR version. As always, we're eager to
https://chat.project-hop.org[hear, window=\"_blank\"] your feedback!
+
+== What is an Apache Release?
+
+Apache Releases are a legal handover of a software project. With each release,
a project hands over the ownership of all items in the release to the Apache
Software Foundations.
+
+Although releases contain source code, documentation etc, the implemented
functionality and fixed bugs are of lesser concern in the release process.
+
+== What is the release process?
+
+The steps to create an Apache release are:
+
+* the community decides to create a release
+* all code is verified to comply with the software licensing requirements.
Checks are performed to make sure there are no license or copyright violations,
no incompatible dependencies etc.
+* the release manager prepares and signs the proposed release materials
+* a https://hop.apache.org/community/team/[PPMC, window=\"_blank\"] member
sends an email to the mailing list to announce the release candidate and
requests the voting to start
+* if the vote passes, the release candidate is accepted and becomes are release
+
+== What is the release review process, how can I help?
+
+=== What is the release review process
+
+A release, or any deliverables for a release should contain or comply to:
+
+* source package that can be built and tested to validate the release
+* release signing: packages must be cryptographically signed. The signature
hash should be included in the [VOTE] mail
+* a LICENSE file, contains all (APL2.0 compatible licenses) used
+* a NOTICE file, contains at least all
https://www.apache.org/legal/src-headers.html#header-existingcopyright[copyright
notices, window=\"_blank\"],
http://apache.org/legal/resolved.html#required-third-party-notices[required
third-party notices, window=\"_blank\"],
https://infra.apache.org/licensing-howto.html#mod-notice[MOD] (Modifications to
NOTICE)
+* all source files submitted to the ASF need to contain the appropriate
http://www.apache.org/legal/src-headers.html#headers[ASF Header,
window=\"_blank\"].
+
+=== How can I help
+
+A lot of the actions listed above will be taken care of by the release manager.
+
+What you can do to review a release:
+
+* verify the deliverables as listed above
+* follow the build instructions (e.g. in the README file) and double check all
steps to (build and) run the release are accurate
+* if you contributed to Hop or any of the plugins for a release, double check
the dependency licenses for compatibility, including dependencies of
dependencies. We run automated checks through
https://creadur.apache.org/rat/[Apache RAT, window=\"_blank\"] as part of the
build, but that may not be infallible.
+
+Vote! After you've reviewed a release candidate, submit your vote to the
mailing list. Specify the review tasks you performed and why you vote to accept
or reject a release candidate.
+
+Reviewing and voting for releases (or release candidates) is an important and
valuable contribution, every vote matters!
+
+== What is the voting process?
+
+=== Procedure
+
+Releases, like all major decisions at the ASF, are accepted or rejected
through a voting process.
+
+When a request to vote for a release is submitted to the dev email list
through a [VOTE] mail, the voting process starts.
+
+In the voting process, the entire community is encouraged to download, test
and review the release candidate.
+
+The voting window lasts at least 72 hours and is closed with a [VOTE RESULTS]
email to the mailing list.
+
+=== Votes
+
+Votes can be cast after review. A vote can be positive (+1) or negative (-1).
A release needs a total of 3 positive votes to pass.
+
+The total of all votes is counted: a release that receive 7 +1 votes and 2 -1
votes will have a total of 5 positive votes and will pass.
+
+In addition to +1 or -1 votes, the voting process allows +0 or -0 or fractal
(e.g. +0.8, -0.2).
+
+=== Binding vs non-binding
+
+In short: PMC member votes are binding, community members votes are
non-binding.
+
+Community votes shouldn't be considered _only_ advisory, they are important
and encouraged, as they can provide valuable input on the quality of a release.
+
+
+Check the detailed voting process
https://www.apache.org/foundation/voting.html[here, window=\"_blank\"].
\ No newline at end of file
