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

[WIP] feat: propose a protocol for loopback-next PR process #5

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

Conversation

raymondfeng
Copy link

@raymondfeng raymondfeng commented Jun 18, 2020

Draft proposal to document/promote our PR process.

@raymondfeng raymondfeng changed the title feat: propose a protocol for loopback-next PR process [WIP] feat: propose a protocol for loopback-next PR process Jun 18, 2020
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

Great initiative!

Would you like to incorporate some content from https://loopback.io/doc/en/contrib/triaging-pull-requests.html too?

- CI is green (with exceptions that the failure is caused by known issues)
- Approved by the owner
- Approved by mandatory reviewers

Copy link
Member

Choose a reason for hiding this comment

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

Let's add also recommended requirements:

  • Code coverage is not decreased. Exceptions are allowed after reviewing which lines of code are not covered by tests.

Comment on lines +57 to +60
- Must have/fix (the author must address such comments)
- Nice to have/fix (the author should try to address such comments but they don't
block the PR from being landed)
- Nitpick (up to the author to decide)
Copy link
Member

Choose a reason for hiding this comment

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

We could consider adopting Conventional Comments:

  • Must have/fix: suggestion(blocking): <message>
  • Nice to have/fix: suggestion(non-blocking): <message>
  • Nitpick: nitpick: <message>

PR will automatically pick up new changes pushed to the same source branch.

Such commits should be squashed and reorganized to maintain a clean history.

Copy link
Member

Choose a reason for hiding this comment

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

Shall we mention a stance against merge commits?

Suggested change
Merge commits
When iterating on a PR, sometimes it may be necessary to pull in the latest changes from upstream to fix potential merge conflicts. A common approach is to use merge commits. However, LoopBack will not accept Merge Commits as they complicate the Git History and make reviewing more difficult. Instead, `git rebase` should be used to apply the PR commits on top of the latest commit from upstream.

community and code matter for us.

Our maintainers are very distributed around the world with different time zones
and work schedules. Some of us are paid full-time IBM employees while others are
Copy link
Member

Choose a reason for hiding this comment

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

I don't think there's anyone being paid fulltime to manage LoopBack anymore.

Suggested change
and work schedules. Some of us are paid full-time IBM employees while others are
and work schedules. Most of us are

Minimum requirements:

- CI is green (with exceptions that the failure is caused by known issues)
- Approved by the owner
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we should give the TSC the ability to act on behalf?

Suggested change
- Approved by the owner
- Approved by the owner or a TSC member

Copy link
Member

Choose a reason for hiding this comment

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

thinking whether it should be TSC member or maintainer.

Copy link
Member

Choose a reason for hiding this comment

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

I suppose that there's no reason why a maintainer can't approve it. Though I wonder what separates them from the code owner? One thing that comes into mind is being pinged for the PR.

With that consideration, should we formalise a process for deciding who becomes a code owner? This is probably out of scope of this PR, but it may be for future consideration.

Copy link
Member

Choose a reason for hiding this comment

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

ah. i see. I misunderstood that the "owner" is the PR author, instead of the code owner. I thought code owner is the maintainers of the repo ?

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

Successfully merging this pull request may close these issues.

4 participants