Skip to content

Update Pull Request template: handling CHANGELOG.md#1243

Merged
joergsteffens merged 5 commits intomasterfrom
dev/joergs/master/pr-template
Sep 9, 2022
Merged

Update Pull Request template: handling CHANGELOG.md#1243
joergsteffens merged 5 commits intomasterfrom
dev/joergs/master/pr-template

Conversation

@joergsteffens
Copy link
Member

@joergsteffens joergsteffens commented Aug 26, 2022

Thank you for contributing to the Bareos Project!

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

General
  • PR name is meaningful
  • Purpose of the PR is understood
  • Separate commit for this PR in the CHANGELOG.md, PR number referenced is same
  • Commit descriptions are understandable and well formatted
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR
  • bareos-check-sources --since-merge does not report any problems
  • git status should not report modifications in the source tree after building and testing

@joergsteffens joergsteffens changed the title Dev/joergs/master/pr template Update Pull Request template: handling CHANGELOG.md Aug 26, 2022
@joergsteffens joergsteffens added the documentation This PR changes only documentation label Aug 26, 2022
@joergsteffens joergsteffens requested a review from pstorz August 26, 2022 13:31
@joergsteffens joergsteffens marked this pull request as ready for review August 26, 2022 14:15
@joergsteffens joergsteffens requested a review from pstorz August 29, 2022 12:14
- [ ] Separate commit for this PR in the CHANGELOG.md, PR number referenced is same
- [ ] Commit descriptions are understandable and well formatted
- [ ] If backport: add original PR number and target branch at top of this file: **Backport of PR#000 to bareos-2x**
- [ ] Separate commit for CHANGELOG.md changes (message: "update CHANGELOG.md" or "update CHANGELOG.md for PR #0000"). PR number is verified.
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos Aug 30, 2022

Choose a reason for hiding this comment

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

Suggested change
- [ ] Separate commit for CHANGELOG.md changes (message: "update CHANGELOG.md" or "update CHANGELOG.md for PR #0000"). PR number is verified.
+- [ ] Separate commit exists for CHANGELOG.md with this PR changes and number placed on top of corresponding section. (message: "update CHANGELOG.md" or "update CHANGELOG.md for PR #0000")

But maybe not better ;-)

@joergsteffens joergsteffens requested a review from pstorz September 1, 2022 15:13
- [ ] Code comments are correct (logically and spelling)
- [ ] Required documentation changes are present and part of the PR
- [ ] `bareos-check-sources --since-merge` does not report any problems
- [ ] `git status` should not report modifications in the source tree after building and testing
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did we remove that line?

Copy link
Member Author

Choose a reason for hiding this comment

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

@pstorz said, that this have not happened for a long time and can therefore be removed.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would have keep it, especially for external contribution, but we can try without and see.

@bruno-at-bareos
Copy link
Contributor

bruno-at-bareos commented Sep 5, 2022

With the new place of comments the section in Changelog, this PR should reorder them, so how to do it become an evidence.

@joergsteffens joergsteffens force-pushed the dev/joergs/master/pr-template branch from 1bb4cc5 to c106d6a Compare September 9, 2022 08:43
@joergsteffens joergsteffens merged commit 51eea4e into master Sep 9, 2022
@joergsteffens joergsteffens deleted the dev/joergs/master/pr-template branch September 9, 2022 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This PR changes only documentation requires backport to 21

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants