GitHawk icon indicating copy to clipboard operation
GitHawk copied to clipboard

Bringing templates to GitHawk

Open Huddie opened this issue 7 years ago • 13 comments
trafficstars

Working on this, if anyone has ideas or suggestions please lmk!

Huddie avatar Nov 04 '18 01:11 Huddie

Yo this is so cool!! Would this work for the “new issue” feature in repos too?

Sent with GitHawk

rnystrom avatar Nov 04 '18 02:11 rnystrom

@rnystrom I’m almost positive! I checked github and all issues are under .github/ISSUE_TEMPLATE

Right now I fetch for specific files but my end plan is fetch all files under that directory, parse the text for the name / description

Should work for all repos!

Sent with GitHawk

Huddie avatar Nov 04 '18 02:11 Huddie

I’ll keep this thread updated with progress

Sent with GitHawk

Huddie avatar Nov 04 '18 02:11 Huddie

@rnystrom Confirmed that it will work across the board. Done for the night 🌙

Huddie avatar Nov 04 '18 05:11 Huddie

https://github.com/GitHawkApp/GitHawk/issues/404

Just gonna link the original ticket for this before GitHub added different template options, maybe no point in supporting the old one if most people have moved to this new system?

Sherlouk avatar Nov 04 '18 12:11 Sherlouk

@Sherlouk the old one being in root/docs/.github rather than strictly .github? I’m not so familiar with github templates, searching online It seemed that you could have as many templates as you want but must be in .github/ISSUE_TEMPLATE directory. Is this not true, can you have templates in other places? Quick note: I’m speaking specifically about issue templates not PR templates

I think for now it’s fine to support this way as if no templates are found it simply opens up the new issue view like it used to. We can expand to support other templates in the future, if others exist.

Sent with GitHawk

Huddie avatar Nov 04 '18 12:11 Huddie

@Huddie Yea so I think the difference is with the new system you can have multiple named templates but previously you could have a single template that was called ISSUE_TEMPLATE.md (and could be in a multitude of places) and would always use that one.

Essentially I think the chain of logic is:

  1. Check for templates in .github/ISSUE_TEMPLATE/ directory
  2. Check for single template called ISSUE_TEMPLATE.md in either root or .github (name not case sensitive)
  3. Just leave it empty

I think for the sake of this, just doing that first one is definitely great progress!

Sherlouk avatar Nov 04 '18 16:11 Sherlouk

Thanks @Sherlouk I will PR number 1 and then maybe expand after that.

Sent with GitHawk

Huddie avatar Nov 04 '18 16:11 Huddie

Really cool!!!

ijm8710 avatar Nov 04 '18 18:11 ijm8710

Me: Curious, so the way it works is to provide a framework on what you’re reporting? Is it the user’s job to replace the template with their report? Is there any way to set it up so it prompts you, this is what you enter here without the need to delete? This is super cool either way but was just curious so that the template is still a reference but also streamlines the input

Huddies reply to me: if you could move this comment to #2393 this thread is more for the release of the feature, that thread is about the feature itself. Quick answer is, templates are a Github thing so we are mimicking the feature as much as possible. No fill ins etc. Just a template of what to write. Unfortunately that means deleting text.

ijm8710 avatar Nov 09 '18 20:11 ijm8710

It could be one day we expand the feature natively

Huddie avatar Nov 09 '18 20:11 Huddie

Yeah understood this is more baseline and it seems awesome. Was just curious if you were on same page as me that this would even have more utility with my suggestion and it sounds like over time it could add a little value. Thanks for the reply and the work!

ijm8710 avatar Nov 09 '18 20:11 ijm8710

this is so cool! is it still on the works? or is it available already in some distribution/beta testing of the app?

superandrew avatar Sep 18 '19 08:09 superandrew