Skip to content

[dev] Break current ISSUE_TEMPLATE into multiple single templates#1933

Merged
sijie merged 1 commit intoapache:masterfrom
sijie:fix_pull_request_templates
Feb 5, 2019
Merged

[dev] Break current ISSUE_TEMPLATE into multiple single templates#1933
sijie merged 1 commit intoapache:masterfrom
sijie:fix_pull_request_templates

Conversation

@sijie
Copy link
Copy Markdown
Member

@sijie sijie commented Feb 2, 2019

Descriptions of the changes in this PR:

Motivation

Following the Github community recommendations (https://github.com/apache/bookkeeper/community)
to break down current ISSUE_TEMPLATE to multiple single templates

Modifications

  • break down the ISSUE_TEMPLATE.md into multiple files in ISSUE_TEMPLATE
  • fix the skip phrase in PULL_REQUEST_TEMPLATE

In order to uphold a high standard for quality for code contributions, Apache BookKeeper runs various precommit
checks for pull requests. A pull request can only be merged when it passes precommit checks. However running all
the precommit checks can take a long time, some trivial changes don't need to run all the precommit checks. You
can check following list to skip the tests that don't need to run for your pull request. Leave them unchecked if
you are not sure, committers will help you:

  • [skip bookkeeper-server bookie tests]: skip testing org.apache.bookkeeper.bookie in bookkeeper-server module.
  • [skip bookkeeper-server client tests]: skip testing org.apache.bookkeeper.client in bookkeeper-server module.
  • [skip bookkeeper-server replication tests]: skip testing org.apache.bookkeeper.replication in bookkeeper-server module.
  • [skip bookkeeper-server tls tests]: skip testing org.apache.bookkeeper.tls in bookkeeper-server module.
  • [skip bookkeeper-server remaining tests]: skip testing all other tests in bookkeeper-server module.
  • [skip integration tests]: skip docker based integration tests. if you make java code changes, you shouldn't skip integration tests.
  • [skip build java8]: skip build on java8. ONLY skip this when ONLY changing files under documentation under site.
  • [skip build java9]: skip build on java9. ONLY skip this when ONLY changing files under documentation under site.


Be sure to do all of the following to help us incorporate your contribution
quickly and easily:

If this PR is a BookKeeper Proposal (BP):

  • Make sure the PR title is formatted like:
    <BP-#>: Description of bookkeeper proposal
    e.g. BP-1: 64 bits ledger is support
  • Attach the master issue link in the description of this PR.
  • Attach the google doc link if the BP is written in Google Doc.

Otherwise:

  • Make sure the PR title is formatted like:
    <Issue #>: Description of pull request
    e.g. Issue 123: Description ...
  • Make sure tests pass via mvn clean apache-rat:check install spotbugs:check.
  • Replace <Issue #> in the title with the actual Issue number.

*Motivation*

Following the Github community recommendations (https://github.com/apache/bookkeeper/community)
to break down current ISSUE_TEMPLATE to multiple single templates

*Modifications*

- break down the `ISSUE_TEMPLATE.md` into multiple files in `ISSUE_TEMPLATE`
- fix the skip phrase in PULL_REQUEST_TEMPLATE
@sijie sijie added the type/task label Feb 2, 2019
@sijie sijie self-assigned this Feb 2, 2019
Copy link
Copy Markdown
Contributor

@eolivelli eolivelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome

@sijie
Copy link
Copy Markdown
Member Author

sijie commented Feb 5, 2019

run pr validation

@sijie sijie added this to the 4.10.0 milestone Feb 5, 2019
@sijie sijie merged commit a08defd into apache:master Feb 5, 2019
@sijie sijie deleted the fix_pull_request_templates branch February 5, 2019 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants