You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by re...@apache.org on 2024/06/19 08:43:42 UTC
(jackrabbit-oak) branch OAK-10881 created (now dc859937e8)
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a change to branch OAK-10881
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
at dc859937e8 OAK-10881: Expand oak/docs/participating with some more guidelines
This branch includes the following new commits:
new dc859937e8 OAK-10881: Expand oak/docs/participating with some more guidelines
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(jackrabbit-oak) 01/01: OAK-10881: Expand oak/docs/participating with some more guidelines
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch OAK-10881
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
commit dc859937e85c97b031e007a58bb88dbdf9ebf14d
Author: Julian Reschke <re...@apache.org>
AuthorDate: Wed Jun 19 09:43:29 2024 +0100
OAK-10881: Expand oak/docs/participating with some more guidelines
---
oak-doc/src/site/markdown/participating.md | 75 +++++++++++++++++++++---------
1 file changed, 54 insertions(+), 21 deletions(-)
diff --git a/oak-doc/src/site/markdown/participating.md b/oak-doc/src/site/markdown/participating.md
index c4c81b1d32..7458a68e76 100644
--- a/oak-doc/src/site/markdown/participating.md
+++ b/oak-doc/src/site/markdown/participating.md
@@ -15,29 +15,62 @@
limitations under the License.
-->
-Participating
--------------
+# Participating
+
+## Mailing Lists
The best place for Oak-related discussions is the [oak-dev@](mailto:oak-dev@jackrabbit.apache.org)
-mailing list. To subscribe, send a message to [oak-dev-subscribe@]
-(mailto:oak-dev-subscribe@jackrabbit.apache.org).
+mailing list. To subscribe, send a message to [oak-dev-subscribe@](mailto:oak-dev-subscribe@jackrabbit.apache.org).
+
+For more details related to various mailing list have a look at http://jackrabbit.apache.org/mailing-lists.html.
+
+## Issue Tracking
Use the [OAK issue tracker](https://issues.apache.org/jira/browse/OAK) to submit issues, comments
-or patches. To subscribe to issue notifications, send a message to [oak-issues@]
-(mailto:oak-issues-subscribe@jackrabbit.apache.org).
-
-The latest Oak sources are available on [GitHub][1]. To subscribe to commit notifications,
-send a message to [oak-commits@] (mailto:oak-commits-subscribe@jackrabbit.apache.org).
-
-For more details related to various mailing list have a look at http://jackrabbit.apache.org/mailing-lists.html
-
-We generally follow a [CTR](https://www.apache.org/foundation/glossary.html#CommitThenReview) policy.
-However it is up to each individual committer to pro-actively ask for a review of a patch on
-oak-dev@ or to even call for a [RTC](https://www.apache.org/foundation/glossary.html#ReviewThenCommit).
-Special care should be taken with backports to maintenance branches. Back ports bear a certain risk
-of introducing regressions to otherwise stable branches. Each back ported change should be carefully
-evaluated for its potential impact, risk and possible mitigation. It is the responsibility of each
-committer to asses these and ask for advise or reviewing on oak-dev@ if uncertain. Whether using
-RTC or CTR is up to the committer.
+or patches. To subscribe to issue notifications, send a message to
+[oak-issues@](mailto:oak-issues-subscribe@jackrabbit.apache.org).
+
+- On "trunk": when done with a ticket, set it to "resolved" and set "Fix Version"
+ to the next unreleased version. Our workflow does not allow re-opening a
+ closed ticket, so we close tickets only when a public release has been made
+ with that change. Until that happens, a ticket can always be re-opened
+ and further work can happen.
+- On maintenance branch (currently 1.22): re-use the existing Jira ticket an
+ just add to "Fix Version" (unless the backport is complex).
+- Add "Affects Version" and "Fix Version" as and when applicable (but not
+ otherwise).
+- Be careful not to include sensitive information (be it in descriptions,
+ attachments, or log files).
-[1]: https://github.com/apache/jackrabbit-oak
+## Source Code
+
+The latest Oak sources are available on [GitHub](https://github.com/apache/jackrabbit-oak).
+To subscribe to commit notifications, send a message to [oak-commits@](mailto:oak-commits-subscribe@jackrabbit.apache.org).
+
+### Making Changes
+
+#### Pull Requests (PRs)
+
+- Minimize PRs; do not modify whitespace/coding style except where needed. This
+ makes them much easier to review, also minimizes confusion when using
+ "git blame".
+- Structure tickets/PRs so that things that can be separated are (that can be
+ useful for backports and reverts).
+- Have test cases (when there's no immediate fix, create a ticket and a PR just
+ for the test and mark it "ignored", pointing to the actual issue).
+- PRs that contain multiple commits in general should be "squashed and merged".
+- When new files are added, make sure they have the proper license on it
+ (in doubt, run the build with "-Prat").
+
+#### Commits
+
+- Always reference an Oak ticket for each commit/PR (this should include the JIRA id
+ in the correct format, e.g. "OAK-10881" instead of "Oak 10881").
+- Avoid committing unfinished stuff; in particular when a release is approaching
+ (see [UNRELEASED](https://issues.apache.org/jira/projects/OAK?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=unreleased))
+
+### Coding Style
+
+- Please avoid wildcard imports.
+- In general be consistent with the style of the code being modified.
+- Avoid TABs, non-ASCII characters, and trailing whitespace.