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

Don't notify CODEOWNERS on editing the CHANGELOG #3749

Merged
merged 1 commit into from
Jan 20, 2024

Conversation

Saransh-cpp
Copy link
Member

Minor update to save us from notifications

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Minor update to save us from notifications
@Saransh-cpp
Copy link
Member Author

The review on this PR was requested automatically (everything is working).

Copy link

codecov bot commented Jan 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5379311) 99.59% compared to head (e235144) 99.59%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3749   +/-   ##
========================================
  Coverage    99.59%   99.59%           
========================================
  Files          258      258           
  Lines        20823    20823           
========================================
  Hits         20738    20738           
  Misses          85       85           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kratman
Copy link
Contributor

kratman commented Jan 20, 2024

I also noticed that the fine grained way we did it causes duplicate requests. On a different PR "maintainers" were requested, then also multiple individual maintainers.

@kratman
Copy link
Contributor

kratman commented Jan 20, 2024

Screenshot_20240120-100659.png

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

Thanks, a reminder that we have towncrier configuration ready for review in #3469 that will eliminate manual edits to the CHANGELOG

@Saransh-cpp
Copy link
Member Author

On a different PR "maintainers" were requested, then also multiple individual maintainers.

The only situation in which this could happen would be if the files in pybamm/ directory and its subdirectories were modified. We can get rid of this edge case by specifying maintainer usernames here, instead of pybamm-team/maintainers -

/pybamm/* @pybamm-team/maintainers # the files directly under /pybamm/, will not recurse

but I guess not a lot of PRs will trigger this. The PR in the screenshot linked by you modifies CITATION.cff and a few file in the subdirectories, triggering the edge case.

@Saransh-cpp Saransh-cpp merged commit 4484514 into develop Jan 20, 2024
40 of 41 checks passed
@Saransh-cpp Saransh-cpp deleted the Saransh-cpp-patch-1 branch January 20, 2024 20:49
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.

None yet

3 participants