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

Add checklist for adding new API #578

Merged

Conversation

XiShanYongYe-Chang
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

In order to avoid missing items when adding new APIs in the Karmada repo, resulting in extended development time, relevant check items are now added.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 8, 2024
@karmada-bot karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 8, 2024
@XiShanYongYe-Chang
Copy link
Member Author

/cc @RainbowMango @windsonsea

Copy link
Member

@samzong samzong left a comment

Choose a reason for hiding this comment

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

According to the context, the K here should be a capital letter.

docs/developers/add-new-api.md Outdated Show resolved Hide resolved
@XiShanYongYe-Chang
Copy link
Member Author

/cc @samzong @windsonsea @RainbowMango

Copy link
Member

@windsonsea windsonsea left a comment

Choose a reason for hiding this comment

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

It is recommended to reduce the usage of phrases such as:

  • "Please" (as it can be overly polite or unnecessary)
  • "We" (using "You" is preferable)

docs/developers/add-new-api.md Outdated Show resolved Hide resolved
docs/developers/add-new-api.md Outdated Show resolved Hide resolved
docs/developers/add-new-api.md Outdated Show resolved Hide resolved
docs/developers/add-new-api.md Outdated Show resolved Hide resolved
@XiShanYongYe-Chang
Copy link
Member Author

@windsonsea Thanks a lot, all comments have been updated.

Copy link
Member

@windsonsea windsonsea left a comment

Choose a reason for hiding this comment

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

/lgtm
Thanks.

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Apr 12, 2024
@XiShanYongYe-Chang
Copy link
Member Author

/cc @RainbowMango

Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

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

/approve

@karmada-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 17, 2024
@karmada-bot karmada-bot merged commit b64f8c7 into karmada-io:main Apr 17, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants