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

Adding a CHANGELOG file #198

Merged
merged 4 commits into from
Aug 24, 2023
Merged

Conversation

PicoCentauri
Copy link
Collaborator

@PicoCentauri PicoCentauri commented Jul 1, 2023

The CHANGELOG is also shown in the documentation as the last entry in the manu. Also, we now have a template for new PRs with a small checklist.

The CHANGELOG is now at version 0.1.5. I also updated the version accordingly.

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

📚 Documentation preview 📚: https://scikit-matter--198.org.readthedocs.build/en/198/

@agoscinski
Copy link
Collaborator

Can we add the changelog with the text up to version 0.1.4 in one commit, and then update the version together with changes in the changelog in another commit? I find it confusing if we mark commit fe58c89 as v0.1.5 commit while the other commit increases the version.

@PicoCentauri
Copy link
Collaborator Author

Yes, good idea. I can change this.

@PicoCentauri
Copy link
Collaborator Author

It is done @agoscinski

CHANGELOG Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
@agoscinski
Copy link
Collaborator

Can you add to the pyproject.toml the changelog?

[project.urls]
homepage = "https://example.com"
documentation = "https://readthedocs.org"
repository = "https://github.com"
changelog = "https://github.com/me/spam/blob/master/CHANGELOG.md"

Source https://peps.python.org/pep-0621/

Copy link
Collaborator

@agoscinski agoscinski left a comment

Choose a reason for hiding this comment

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

Also could you switch from alpha to beta in pyproject.toml

     "Development Status :: 4 - Beta"

src/skmatter/__init__.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@agoscinski agoscinski left a comment

Choose a reason for hiding this comment

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

Thanks, looks good now!

@agoscinski agoscinski merged commit 4dd708d into scikit-learn-contrib:main Aug 24, 2023
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.

2 participants