Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 2.14 KB

CONTRIBUTING.adoc

File metadata and controls

47 lines (36 loc) · 2.14 KB
Raw

Whenever you want to commit a change to the skupper-router repo, please first create a PR so it can be reviewed and approved by others. When creating a PR, please use the following commit message pattern

Fixes #<github-issue-number>: <Commit message in present tense>

For example,

Fixes #90: Fix code in http2 adaptor that was doing improper q2 related logging

In the above commit message, #90 refers to the github issue - #90 (you will need to create an issue if there isn’t already one)

After the PR is approved, please use the Github PR "Squash and merge" button to commit your changes to the main branch. Please refrain from directly committing your work to the main branch. The following things happen when using the "Squash and merge" button to commit your changes:

  1. The PR is automatically closed

  2. The github issue #90 is closed

  3. The commit on the main branch is referenced in issue #90

  4. There is a hyperlink to the Github issue #90 from the commit.

For porting upstream qpid-dispatch issues to skupper-router you might use the standard DISPATCH-XXXX: <Commit message> in your commit message but make sure you commit your change via the Github "Squash and merge" button.

Please pull up any open PR on the skupper-router and make sure you see the "Squash and merge" button. Merge commits are not allowed on skupper-router.