{{gitpr|####}} for Wiki
Moderator: GZDoom Developers
-
- Posts: 8197
- Joined: Sun Jan 28, 2007 3:55 pm
- Preferred Pronouns: He/Him
- Location: QZDoom Maintenance Team
{{gitpr|####}} for Wiki
When new features are added, sometimes they are with multiple commits to the github which makes it inconvenient to see the files as a whole and what all the changes entail. So I'd like to recommend a {{gitpr|####}} that says something indicates similar to what {{git|SHA}} does to indicate it's only available as of the time of its merging.
-
- Posts: 13836
- Joined: Tue Jan 13, 2004 1:31 pm
- Preferred Pronouns: She/Her
Re: {{gitpr|####}} for Wiki
I think it would be wise to leave this open for discussion, as I am not sure how many people really want features not yet available in the devbuilds to be documented alongside usable stuff, I'd like to see how many people would be in favor or opposed to that.
-
- Posts: 8197
- Joined: Sun Jan 28, 2007 3:55 pm
- Preferred Pronouns: He/Him
- Location: QZDoom Maintenance Team
Re: {{gitpr|####}} for Wiki
The reason to document them sooner than later is because I, for example, have a notorious memory. After a while I can forget what certain things do when I make a submission so it's far better to document it well ahead of time.
Not to mention people excited to use them can have the features available sooner with documentation so they can start screwing around with it. We've been doing this for many years after all. This is what we did with ZScript in its entirety and every new features, we just slap a {{git|SHA}} onto it and then people can get a devbuild when its ready and start checking it out.
Also this would only apply to PRs that actually do merge into GZDoom.
Not to mention people excited to use them can have the features available sooner with documentation so they can start screwing around with it. We've been doing this for many years after all. This is what we did with ZScript in its entirety and every new features, we just slap a {{git|SHA}} onto it and then people can get a devbuild when its ready and start checking it out.
Also this would only apply to PRs that actually do merge into GZDoom.
-
- Posts: 13836
- Joined: Tue Jan 13, 2004 1:31 pm
- Preferred Pronouns: She/Her
Re: {{gitpr|####}} for Wiki
Ah, I see, good point then.
https://zdoom.org/wiki/Template_talk:Gitpr
I am sure that could be improved, but there's a start. I don't use MediaWiki much.
https://zdoom.org/wiki/Template_talk:Gitpr
I am sure that could be improved, but there's a start. I don't use MediaWiki much.
-
- Posts: 5032
- Joined: Sun Nov 14, 2010 12:59 am
Re: {{gitpr|####}} for Wiki
I personally don't think this is really necessary; GitHub shows what PR a commit comes from, if any.
When tagging a feature on the wiki, you can use the merge commit hash located at the bottom of the PR page. The only little problem is that the git template doesn't link directly to GitHub. It instead links to the changelog page on the ZDoom site. This can be solved easily by updating the template, however.
Another thing is that not every feature that spans multiple commit would have an associated PR.
When tagging a feature on the wiki, you can use the merge commit hash located at the bottom of the PR page. The only little problem is that the git template doesn't link directly to GitHub. It instead links to the changelog page on the ZDoom site. This can be solved easily by updating the template, however.
Another thing is that not every feature that spans multiple commit would have an associated PR.
You do not have the required permissions to view the files attached to this post.
-
- Posts: 8197
- Joined: Sun Jan 28, 2007 3:55 pm
- Preferred Pronouns: He/Him
- Location: QZDoom Maintenance Team
Re: {{gitpr|####}} for Wiki
...Why do they have to make that so difficult to see on github?
But that actually does sound like a good idea too. Had I known/remembered that was a thing I would've started off in that direction as well instead.
But that actually does sound like a good idea too. Had I known/remembered that was a thing I would've started off in that direction as well instead.
-
- Posts: 2123
- Joined: Thu May 02, 2013 1:27 am
- Operating System Version (Optional): Windows 10
- Graphics Processor: nVidia with Vulkan support
- Location: Brazil
Re: {{gitpr|####}} for Wiki
I feel like linking it to a PR number would be more reliable than linking to a commit ID. PRs can have more things committed to them or even be force pushed (in which case the original commit will even be deleted entirely from Github!), which would cause issues with something based on commit hashes, whereas the PR ID won't change.
-
- Posts: 13836
- Joined: Tue Jan 13, 2004 1:31 pm
- Preferred Pronouns: She/Her
Re: {{gitpr|####}} for Wiki
PR's can also show multiple commits, and a lot of them get merged as-is that way. So it still can be useful.
Nevertheless, it's there. If it's an unwelcome addition, there's a lot of wiki admins that can simply erase it from existence, I won't lose sleep if it has to go away. Ultimately I hope it will be helpful.
Nevertheless, it's there. If it's an unwelcome addition, there's a lot of wiki admins that can simply erase it from existence, I won't lose sleep if it has to go away. Ultimately I hope it will be helpful.
-
- Posts: 8197
- Joined: Sun Jan 28, 2007 3:55 pm
- Preferred Pronouns: He/Him
- Location: QZDoom Maintenance Team
Re: {{gitpr|####}} for Wiki
Yeah, I'm still going to use it no matter what.