Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added the definition of done to the github templates #17801

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

joemoe
Copy link

@joemoe joemoe commented Nov 15, 2021

This is a companion PR for the one i just created in the flink-web repo to introduce a definition of done: apache/flink-web#481

To increase awareness for coding standards, test and documentation we are suggesting to introduce a definition of done.

The goal of this initiative:

increase the stability of master
increase test coverage
increase awareness for code quality
improve documentation

@flinkbot
Copy link
Collaborator

flinkbot commented Nov 15, 2021

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@flinkbot
Copy link
Collaborator

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 31d7883 (Mon Nov 15 21:23:08 UTC 2021)

Warnings:

  • No documentation files were touched! Remember to keep the Flink docs up to date!
  • Invalid pull request title: No valid Jira ID provided

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.


The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@Airblader
Copy link
Contributor

Airblader commented Nov 15, 2021

The template is starting to accumulate an awful lot of questions to answer. I would raise the question how helpful this really is, a large number of PRs don't even bother answering any of the questions and it doesn't seem to bother anyone.

At the very least we could improve the DX by making it checkboxes. Those can just be clicked and don't require moving your cursor, removing the possible answers, then adding your answer, and doing that for every single question. Something like

- [ ] I have adjusted the documentation to reflect the changes made or introduced in this pull request.

@zentol
Copy link
Contributor

zentol commented Nov 16, 2021

I don't think this is helpful.

  1. is often not followed, and we don't force people to do so
  2. is checked by CI (so why mention it?)
  3. Why should we force documentation updates in the same PR? So long as the documentation does get updated (e.g., like in [FLINK-24876][docs] Remove metrics limitation of Adaptive Scheduler #17766) it doesn't matter.
  4. is sometimes not possible/necessary
  5. is checked by CI (so why mention it?)

@@ -9,3 +9,4 @@ To make the process smooth for the project *committers* (those who review and ac
Please check out the [How to Contribute guide](https://flink.apache.org/contributing/how-to-contribute.html) to understand how contributions are made.
A detailed explanation can be found in our [Contribute Code Guide](https://flink.apache.org/contributing/contribute-code.html) which also contains a list of coding guidelines that you should follow.
For pull requests, there is a [check list](PULL_REQUEST_TEMPLATE.md) with criteria taken from the How to Contribute Guide and the Coding Guidelines.
In order to get the change merged make sure the [Definition of Done](https://flink.apache.org/contributing/contribute-code.html#definition-of-done) is fullfilled.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In order to get the change merged make sure the [Definition of Done](https://flink.apache.org/contributing/contribute-code.html#definition-of-done) is fullfilled.
In order to get the change merged make sure the [Definition of Done](https://flink.apache.org/contributing/contribute-code.html#definition-of-done) is fulfilled.

@Airblader
Copy link
Contributor

Why should we force documentation updates in the same PR?

I do think updating the docs in the same PR is a good practice and would +1 it. We merge directly to master, not to feature branches, and we should expect anything merged to master to be documented just as much as we expect it to build. I don't think that we should be treating documentation as a second-class citizen here.

Copy link

This PR is being marked as stale since it has not had any activity in the last 180 days.
If you would like to keep this PR alive, please leave a comment asking for a review.
If the PR has merge conflicts, update it with the latest from the base branch.

If you are having difficulty finding a reviewer, please reach out to the [community](https://flink.apache.org/what-is-flink/community/).

If this PR is no longer valid or desired, please feel free to close it. If no activity occurs in the next 90 days, it will be automatically closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants