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

Add changelog project URL #58

Merged
merged 1 commit into from
May 10, 2020
Merged

Add changelog project URL #58

merged 1 commit into from
May 10, 2020

Conversation

scop
Copy link
Contributor

@scop scop commented May 5, 2020

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?

Code changes:

  • Did you format your code with Black?
    • black getmac tests
  • Are the linting checks passing?
    • tox -e check
  • Do all tests pass locally?
    • tox
  • Have you updated the CHANGELOG with a summary of your change?
  • Did you add your name to the contributors list in the README?

Summary of changes:

Background info at
pypi/warehouse#7882 (comment)

@GhostofGoes
Copy link
Owner

While the changelog is already included on the bottom of the PyPI description I suppose it doesn't hurt to have a link to the file as well.

@GhostofGoes GhostofGoes merged commit 3569b7c into GhostofGoes:master May 10, 2020
@scop
Copy link
Contributor Author

scop commented May 10, 2020

Thanks! The point of the link is consistency; most projects maintain a changelog, but without these links it has to be hunted down differently for each project. Some have it in README, sometimes top, sometimes bottom, sometimes embedded, sometimes not there at all. With a project URL in metadata, it's always easily accessible in the same place.

@scop scop deleted the changelog-project-url branch May 10, 2020 05:54
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