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

feat(plugin-git): add composables #398

Merged
merged 6 commits into from
Mar 11, 2025
Merged

feat(plugin-git): add composables #398

merged 6 commits into from
Mar 11, 2025

Conversation

Mister-Hope
Copy link
Member

No description provided.

@Mister-Hope Mister-Hope requested a review from pengzhanbo March 7, 2025 02:54
@coveralls
Copy link

coveralls commented Mar 7, 2025

Pull Request Test Coverage Report for Build 13785042715

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 59.533%

Totals Coverage Status
Change from base Build 13785012523: 0.0%
Covered Lines: 1358
Relevant Lines: 2059

💛 - Coveralls

@Mister-Hope Mister-Hope marked this pull request as draft March 7, 2025 03:34
@Mister-Hope
Copy link
Member Author

Mister-Hope commented Mar 7, 2025

TODO:

  1. Update changelog component class name with vp prefix
  2. Reduce page data size

RFC here:

  1. git username is definitely not equalized to GitHub username, while the plugin is doing this as default behavior. I think Gravatar with email should be always preferred.
  2. There are likely users contributing with both noreply and own emails, we need to special mention it in docs and provide guidelines for users merging contributors easily (probably provide utils functions to avoid writing complicated functions like this: https://github.com/vuepress-theme-hope/vuepress-theme-hope/blob/ce8916d7eee286c4238e811adf59c1d847a402cd/docs-shared/src/theme-wrapper.ts#L94-L127)
  3. When detecting a noreply email, I think this should be removed in the commit info.

@pengzhanbo
Copy link
Member

pengzhanbo commented Mar 8, 2025

git username is definitely not equalized to GitHub username, while the plugin is doing this as default behavior.

In ContributorsOptions.info, the username is configured as the username for the git service provider. It is inevitable that git.name in the git configuration does not equal the GitHub username, which is why there is an alias option; it allows users to be quickly merged into the correct username.

I think Gravatar with email should be always preferred.

When it is clear that the username is a GitHub username, using avatars.githubusercontent.com is reasonable; in other cases, Gravatar is used as a fallback.

There are likely users contributing with both noreply and own emails, we need to special mention it in docs and provide guidelines for users merging contributors easily

The plugin will extract the username from the noreply email using getUserNameWithNoreplyEmail().

When detecting a noreply email, I think this should be removed in the commit info.

A noreply email is generally used by users who wish to keep their email addresses private when commits, so it cannot be assumed that submissions from noreply emails can be disregarded.

@Mister-Hope Mister-Hope marked this pull request as ready for review March 11, 2025 10:33
@Mister-Hope Mister-Hope merged commit 9928363 into main Mar 11, 2025
34 checks passed
@Mister-Hope Mister-Hope deleted the git-composable branch March 11, 2025 10:34
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.

3 participants