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

Require clear descriptions both for feature and breaking PRs prior to the merge #28112

Merged
merged 3 commits into from
Nov 19, 2023

Conversation

delvh
Copy link
Member

@delvh delvh commented Nov 18, 2023

When writing the release blog, it is really annoying and time-consuming to re-discover and write down how a feature behaves and capture a screenshot of it, for every single feature merged since the last release.
This should not be the responsibility of maintainers, but rather of the person implementing a feature in the first place.
They know best how to use the feature and how to gather screenshots for it.
Similarly for breaking changes and their effects.

As such, let's require everything to be up-to-date and easily understandable before merging features or breaking changes.

@delvh delvh added type/docs This PR mainly updates/creates documentation topic/build PR changes how Gitea is built, i.e. regarding Docker or the Makefile skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. labels Nov 18, 2023
@delvh delvh added this to the 1.22.0 milestone Nov 18, 2023
@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Nov 18, 2023
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 18, 2023
@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Nov 18, 2023
Copy link
Member

@denyskon denyskon left a comment

Choose a reason for hiding this comment

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

I'd also like to make correct labels a requirement before merging, but that's a responsibility of the corresponding maintainers, not the PR author.

@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Nov 18, 2023
@delvh
Copy link
Member Author

delvh commented Nov 18, 2023

Should I add it to this PR?

@delvh
Copy link
Member Author

delvh commented Nov 18, 2023

Another requirement for merging PRs is that the PR is labeled correctly.
However, this is not your job as a contributor, but the job of the person merging your PR.

How about that?

@denyskon
Copy link
Member

Sounds good. Maybe add:

If you think that your PR was labeled incorrectly, or notice that it was merged without labels, please let us know.

@delvh
Copy link
Member Author

delvh commented Nov 18, 2023

Labels are now required to be correct too.

@lunny lunny merged commit 0bf021d into go-gitea:main Nov 19, 2023
25 checks passed
@delvh delvh deleted the documentation/harden-pr-merge-requirements branch November 19, 2023 09:57
zjjhot added a commit to zjjhot/gitea that referenced this pull request Nov 20, 2023
* upstream/main:
  [skip ci] Updated translations via Crowdin
  Update JS and PY dependencies (go-gitea#28120)
  Decrease issue font size in project template (go-gitea#28054)
  Require clear descriptions both for feature and breaking PRs prior to the merge (go-gitea#28112)
  add skip ci functionality (go-gitea#28075)
  Fix project counter in organization/individual profile (go-gitea#28068)
  Fix Show/hide filetree button on small displays (go-gitea#27881)
  Change default size of attachments and repo files (go-gitea#28100)
  Fix Matrix and MSTeams nil dereference (go-gitea#28089)
fuxiaohei pushed a commit to fuxiaohei/gitea that referenced this pull request Jan 17, 2024
… the merge (go-gitea#28112)

When writing the release blog, it is really annoying and time-consuming
to re-discover and write down how a feature behaves and capture a
screenshot of it, for every single feature merged since the last
release.
This should not be the responsibility of maintainers, but rather of the
person implementing a feature in the first place.
They know best how to use the feature and how to gather screenshots for
it.
Similarly for breaking changes and their effects.

As such, let's require everything to be up-to-date and easily
understandable before merging features or breaking changes.
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Feb 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/docs size/S Denotes a PR that changes 10-29 lines, ignoring generated files. skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. topic/build PR changes how Gitea is built, i.e. regarding Docker or the Makefile type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants