You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-issues@jackrabbit.apache.org by "Julian Reschke (Jira)" <ji...@apache.org> on 2024/06/12 13:24:00 UTC

[jira] [Created] (OAK-10881) Expand oak/docs/participating with some more guidelines

Julian Reschke created OAK-10881:
------------------------------------

             Summary: 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


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 "fixVersion" to the next unreleased version
- maintenance branch: re-use the existing Jira ticket and just add to "fixVersion" (unless the backport is complex)
- avoid committing unfinished stuff to trunk; in particular when a release is approaching


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)