search

jaraco / skeleton

A generic project skeleton for Python projects.
http://blog.jaraco.com/skeleton/
MIT License
123 stars 36 forks source link

No support for linking usernames #144

Closed jaraco closed 3 months ago

jaraco commented 3 months ago

In https://github.com/jaraco/jaraco.collections/pull/16, the author referenced themselves in the news fragment, but that caused the release to fail (late, only after finalizing the release).

They got the impression they could use this syntax because it was contributed downstream to Setuptools but not to other projects.

We should probably add support for that in all skeleton and coherent projects.

Of course, the way it's implemented is not sustainable because the config requires hard-coded values.

Avasam commented 3 months ago

Oh darn, I've been doing the same for other newly typed skeleton-based projects.

I don't suppose any of this could be pulled from git data when building docs? (idk if the project is checked out just copied)

git config --get remote.origin.url
# or
git ls-remote --get-url origin

Actually github_repo_url is hardcoded per-repo, but I don't see where it's used. :user: looks like it should work for any repo.

jaraco commented 3 months ago

Oh! Great observation. Yes, that should be trivial to add. I'll do that.

jaraco commented 3 months ago

I'm wondering which is best - github.com/{username} or github.com/sponsors/{username}. My instinct would be to simply link to the user, and let a potential sponsor traverse to the sponsors page if appropriate. It feels a little sketchy to drive users to the sponsors URL when all they're doing is clicking on the "user". After musing about it for a moment, I think I prefer the non-sponsors page. Let's go with that for now until someone else is willing to make the case for the sponsors page.

Avasam commented 3 months ago

It's also odd if there user hasn't setup sponsors. I'm in favor of linking to the profile page as well.