[
https://issues.apache.org/jira/browse/OAK-10881?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Stefan Egli updated OAK-10881:
------------------------------
Description:
Proposal:
Tickets/PRs/Workflow:
- Always reference an Oak ticket for each commit/PR (this should include the
jira id in the correct format, eg OAK-10881 instead of Oak 10881)
- minimize PRs; do not modify whitespace/coding style except where needed
- structure tickets/PRs so that things that can be separated are (that can be
useful for backports)
- 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)
- trunk: when done with a ticket, set it to "resolved" and set "Fix Version" to
the next unreleased version
- maintenance branch: re-use the existing Jira ticket and just add to "Fix
Version" (unless the backport is complex)
- avoid committing unfinished stuff to trunk; in particular when a release is
approaching
- add affects-version and fix-version as and when applicable
- PRs that contain multiple commits in general should be "squashed and merged"
Coding Style:
- no wildcard imports
- in general be consistent with the style of the code being modified
- avoid TABs and trailing whitespace
was:
Proposal:
Tickets/PRs/Workflow:
- Always reference an Oak ticket for each commit/PR
- minimize PRs; do not modify whitespace/coding style except where needed
- structure tickets/PRs so that things that can be separated are (that can be
useful for backports)
- 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)
- trunk: when done with a ticket, set it to "resolved" and set "Fix Version" to
the next unreleased version
- maintenance branch: re-use the existing Jira ticket and just add to "Fix
Version" (unless the backport is complex)
- avoid committing unfinished stuff to trunk; in particular when a release is
approaching
- add affects-version and fix-version as and when applicable
- PRs that contain multiple commits in general should be "squashed and merged"
Coding Style:
- no wildcard imports
- in general be consistent with the style of the code being modified
- avoid TABs and trailing whitespace
> Expand oak/docs/participating with some more guidelines
> -------------------------------------------------------
>
> Key: OAK-10881
> URL: https://issues.apache.org/jira/browse/OAK-10881
> Project: Jackrabbit Oak
> Issue Type: Documentation
> Components: doc
> Reporter: Julian Reschke
> Assignee: Julian Reschke
> Priority: Minor
>
> Proposal:
> Tickets/PRs/Workflow:
> - Always reference an Oak ticket for each commit/PR (this should include the
> jira id in the correct format, eg OAK-10881 instead of Oak 10881)
> - minimize PRs; do not modify whitespace/coding style except where needed
> - structure tickets/PRs so that things that can be separated are (that can be
> useful for backports)
> - 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)
> - trunk: when done with a ticket, set it to "resolved" and set "Fix Version"
> to the next unreleased version
> - maintenance branch: re-use the existing Jira ticket and just add to "Fix
> Version" (unless the backport is complex)
> - avoid committing unfinished stuff to trunk; in particular when a release is
> approaching
> - add affects-version and fix-version as and when applicable
> - PRs that contain multiple commits in general should be "squashed and merged"
> Coding Style:
> - no wildcard imports
> - in general be consistent with the style of the code being modified
> - avoid TABs and trailing whitespace
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
