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

Consider a pull request template for breaking changes #424

Open
paddyroddy opened this issue Nov 14, 2024 · 2 comments · May be fixed by #463
Open

Consider a pull request template for breaking changes #424

paddyroddy opened this issue Nov 14, 2024 · 2 comments · May be fixed by #463
Assignees
Labels
enhancement New feature or request

Comments

@paddyroddy
Copy link
Member

Is Your Feature Request Related to a Problem? Please Describe

Making releases (#390) are hard currently due to the need to inform users about possible breaking changes, as the API isn't guaranteed to be backwards compatible. Is there a way we could improve PRs so that making the necessary CHANGELOG would be easy in future?

Describe the Solution You'd Like

No response

Describe Alternatives You've Considered

No response

Additional Context

No response

@paddyroddy paddyroddy added the enhancement New feature or request label Nov 14, 2024
@Saransh-cpp
Copy link
Member

One thing that we do at PyBaMM is make developers add a CHANGELOG note in every PR that introduces a user facing change. Should we do that in GLASS as well, or should I just add a PR template that makes it easier for developers to write what user-facing change this PR is adding?

cc: @ntessore

@paddyroddy
Copy link
Member Author

I guess it would be good to document what we want in this. Some thoughts:

  • Is your code passing linting?
  • Is your code passing tests?
  • Have you written tests if it's a new feature?
  • Have you modified/extended the documentation?
  • Are you adding a public function which should be exposed in sphinx?

Saransh-cpp added a commit that referenced this issue Nov 28, 2024
@Saransh-cpp Saransh-cpp linked a pull request Nov 28, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants