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

Changelog: add links to contributors #243

Merged
merged 1 commit into from
Jan 10, 2024

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Jan 10, 2024

Description

Prior to the repo take-over, the changelog was maintained in a PEAR package.xml file using a format as expected for that file, which did not allow for links.

Since PEAR support has been dropped in version 3.8.0, the changelog was moved to a Markdown file.

This PR is a first effort to improve the usefulness of the changelog by improving the "giving credit where credit is due" part of the changelog.

A best effort has been made to add links for all contributors named in the changelog.

  • Whenever possible, a GitHub profile link has been used.
  • For older contributions via PEAR, the PEAR user profile link has been used unless their GitHub username could be determined with a high degree of certainty.

Unfortunately, for some contributions, my code archaeology effort have proven in vain and I have not been able to trace the name of the contributor back to a user profile.

👉 If this applies to a contribution you made, please submit a pull request to update the changelog to include a link to your profile.

Note: this may seem like a lot of effort for a changelog/historical information. However, to me, this is about creating a positive climate open for contributions and that makes it important (to me).

Suggested changelog entry

N/A

Prior to the repo take-over, the changelog was maintained in a PEAR `package.xml` file using a format as expected for that file, which did not allow for links.

Since PEAR support has been dropped in version 3.8.0, the changelog was moved to a Markdown file.

This PR is a first effort to improve the usefulness of the changelog by improving the "giving credit where credit is due" part of the changelog.

A best effort has been made to add links for all contributors named in the changelog.

* Whenever possible, a GitHub profile link has been used.
* For older contributions via PEAR, the PEAR user profile link has been used unless their GitHub username could be determined with a high degree of certainty.

Unfortunately, for some contributions, my code archaeology effort have proven in vain and I have not been able to trace the name of the contributor back to a user profile.

:point_right: If this applies to a contribution **_you_** made, please submit a pull request to update the changelog to include a link to your profile.

Note: this may seem like a lot of effort for a changelog/historical information. However, to me, this is about creating a positive climate open for contributions and that makes it important (to me).
@jrfnl jrfnl added this to the 3.x Next milestone Jan 10, 2024
@jrfnl jrfnl enabled auto-merge January 10, 2024 00:22
@jrfnl jrfnl merged commit 021f82d into master Jan 10, 2024
40 checks passed
@jrfnl jrfnl deleted the feature/changelog-contributor-links branch January 10, 2024 00:27
@jrfnl jrfnl mentioned this pull request Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant