website icon indicating copy to clipboard operation
website copied to clipboard

Created standard issue form for feasibility

Open jdingeman opened this issue 1 year ago • 24 comments

Fixes #2298

What changes did you make and why did you make them ?

  • Added feasibility-issue-form.yml to have a standard issue form template

Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)

No visual changes to website.

jdingeman avatar Jul 28 '22 04:07 jdingeman

I was not sure how to test this out within my local repository to view it. If anyone could show me how that'd be awesome!

jdingeman avatar Jul 28 '22 04:07 jdingeman

Want to review this pull request? Take a look at this documentation for a step by step guide!

From your project repository, check out a new branch and test the changes.

git checkout -b jdingeman-feasibility-issue-form gh-pages
git pull https://github.com/jdingeman/website.git feasibility-issue-form

github-actions[bot] avatar Jul 28 '22 04:07 github-actions[bot]

Availability: 6 Hours ETA: EOD 2022-07-29

arpitapandya avatar Jul 28 '22 14:07 arpitapandya

  • I would create a unique label above the line options (in the case of checkboxes and dropdowns) and remove key label(3x) with only instruction examples(3x). for e.g. after line 28 you can add a line with label and then remove key label on line 30,31,32. Same thing you can do for the checkboxes for feasibility-items because as per the guide you may want to avoid duplication error so you can also set that as array reference
  • on Line 24 can you fix the typo to attributes?
  • on Line 36 can you fix the typo to checklist?
  • on line 15 I think I would select the type value textarea(if someone have to write 2 sentences, I think input will allow one line(allows to add first name, last name )
  • I went through the guide, syntax you have used are correct.

Sorry, you can also keep the options label for e.g. options: - label: Instruction example 1 - label: Instruction example 2 - label: Instruction example 3 or options: - Instruction example 1 - Instruction example 2 - Instruction example 3 both are fine but it will require to have a unique label with a string for the options(which is missing).

arpitapandya avatar Jul 28 '22 20:07 arpitapandya

Hello @arpitapandya, I've made the changes to the best of my understanding. Please let me know if I have misunderstood anything. Thank you!!

jdingeman avatar Jul 30 '22 19:07 jdingeman

Hello @arpitapandya, I've made the changes to the best of my understanding. Please let me know if I have misunderstood anything. Thank you!!

@jdingeman Thanks for the changes. Can you fix the indentation error coming from line 45 so that we can preview it. ymlSyntaxError

arpitapandya avatar Jul 30 '22 23:07 arpitapandya

I was not sure how to test this out within my local repository to view it. If anyone could show me how that'd be awesome!

I was doing research on how to preview, I think, by going to the file on your GitHub under website repo from the branch you created, It will allow to preview it, that's how I am seeing if there're no syntax error.

arpitapandya avatar Jul 30 '22 23:07 arpitapandya

ETA: 2-3 Availability: 22-8-1

blulady avatar Jul 31 '22 17:07 blulady

Hey Justin, Just wanted to say great work on this issue, there is a lot here. Arpita is right, I am also getting an error when I push your branch up to my github repo and then make this branch the default branch from the branches link under settings .

like this

Screenshot (206)

I am getting this error: YAML syntax error: (): did not find expected '-' indicator while parsing a block collection at line 45 column 6. Learn more.

blulady avatar Aug 01 '22 18:08 blulady

Hi @arpitapandya and @blulady, I added the indentations and tried to view it through my local repo. I am getting this syntax error

image

Do you know what the expected key should be?

jdingeman avatar Aug 02 '22 21:08 jdingeman

Hi @arpitapandya and @blulady, I added the indentations and tried to view it through my local repo. I am getting this syntax error

image

Do you know what the expected key should be?

@jdingeman That error is coming because of the indentation error, can you remove the space before validations on line 51 please. If it gives you error I would suggest remove the line and type it, it's just because of the space you have added by mistake between line 44 to 52 indentation. In case you wanna use the tool. It will validate.

arpitapandya avatar Aug 03 '22 01:08 arpitapandya

@arpitapandya thank you so much! I managed to get the file to display as a form on my repo. Let me know what you think. PS. Thank you for the tool! It'll be very useful.

jdingeman avatar Aug 03 '22 02:08 jdingeman

That tool is a delight. Nice find @arpitapandya

blulady avatar Aug 04 '22 20:08 blulady

So it is looking really good!! I think there are only a few more changes that need to be added before this template is complete. Looking at issue #2298

  • there needs to be a title for the issue that the template will be filled out for
  • there needs to be an input box if you check yes for a dependency

@jdingeman you may add this https://github.com/hackforla/website/pull/3436#pullrequestreview-1054605483 as @blulady suggested to add input box for the dependency label.

  • Also, I am not sure, if you were able to use the extension in VS code, It's such a time saver and catches the error and will guide you what should be removed and allowed.

arpitapandya avatar Aug 05 '22 06:08 arpitapandya

Hello @blulady and @arpitapandya, I've added the drop down, but I'm not sure if the formatting is correct. Is the drop down used to generate the checklist? Or should the checklist stay there regardless of if "Yes" is selected for "Is there a dependency?"

Also @arpitapandya, thank you for linking that extension! It helped me see some of the unnecessary properties I had added.

jdingeman avatar Aug 08 '22 01:08 jdingeman

Hello @blulady and @arpitapandya, I've added the drop down, but I'm not sure if the formatting is correct. Is the drop down used to generate the checklist? Or should the checklist stay there regardless of if "Yes" is selected for "Is there a dependency?"

Also @arpitapandya, thank you for linking that extension! It helped me see some of the unnecessary properties I had added. Thanks for working on it! I am on call for PR's on Thursday. I hope someone reviews this before then but I will be reviewing it on Thursday if not.

blulady avatar Aug 10 '22 02:08 blulady

Hello @blulady and @arpitapandya, I've added the drop down, but I'm not sure if the formatting is correct. Is the drop down used to generate the checklist? Or should the checklist stay there regardless of if "Yes" is selected for "Is there a dependency?" Also @arpitapandya, thank you for linking that extension! It helped me see some of the unnecessary properties I had added. Thanks for working on it! I am on call for PR's on Thursday. I hope someone reviews this before then but I will be reviewing it on Thursday if not.

  • For the dependency label my understanding is if you can make it like example form as stated in issue then an input for what it is if yes)
  • Can you move dependency after title (first title, Dependency and then Overview in order as per the issue)?
  • For the Action Items and Checklist I saw you made changes, I would love to learn from @blulady before I jump and make an assumption as I am not too sure. Again, Thanks @jdingeman for constantly following up and working on this issue by making changes.

arpitapandya avatar Aug 10 '22 21:08 arpitapandya

@blulady and @arpitapandya, now that I look at it, I am curious if the action items and instructions should be checklists by default, or appear as textarea for user input like the blank form

With checklists
With textareas

#2298 uses this form as an example, so I imagine they both would need checklists instead of textareas.

jdingeman avatar Aug 10 '22 22:08 jdingeman

@blulady and @arpitapandya, now that I look at it, I am curious if the action items and instructions should be checklists by default, or appear as textarea for user input like the blank form

With checklists With textareas #2298 uses this form as an example, so I imagine they both would need checklists instead of textareas.

@jdingeman So, the issue indicates that the resulting form should be as form, consider it as .md and creating .yml version for that.

  • I don't think textarea will generate checklist for how the feasibility tests should look like. I would make as listed in the demo.
  • correct me if I am wrong @blulady

arpitapandya avatar Aug 11 '22 12:08 arpitapandya

@blulady and @arpitapandya, now that I look at it, I am curious if the action items and instructions should be checklists by default, or appear as textarea for user input like the blank form

With checklists With textareas #2298 uses this form as an example, so I imagine they both would need checklists instead of textareas.

That is a lot of work @jdingeman. You have done a great job getting to know how to create an issue template in a few different ways. Your template has a title, a dependency drop down (which looks like the form cited in the issue your issue cites and while it is not technically a "checkbox" it does match the example), there is an overview text area, there is a resources/instructions text area and while there is a feasibility area it is not a checklist. Personally I like checkboxes because they can check off what is done but these won't be as specific and therefore not as helpful I feel like there is room for interpretation because instead of linking a specific form for an example, an entire other issue is linked. I think it would be fine approving this issue but we could also bring it up to Bonnie in Sunday's meeting to get clarification. You've put in a ton of work on this so I will leave it up to you.

blulady avatar Aug 11 '22 20:08 blulady

@blulady and @arpitapandya, now that I look at it, I am curious if the action items and instructions should be checklists by default, or appear as textarea for user input like the blank form With checklists With textareas #2298 uses this form as an example, so I imagine they both would need checklists instead of textareas.

That is a lot of work @jdingeman. You have done a great job getting to know how to create an issue template in a few different ways. Your template has a title, a dependency drop down (which looks like the form cited in the issue your issue cites and while it is not technically a "checkbox" it does match the example), there is an overview text area, there is a resources/instructions text area and while there is a feasibility area it is not a checklist. I think that the feasibility check boxes will need a text area below them for specification. There is room for interpretation because instead of linking a specific form for an example, an entire other issue is linked. I think it would be fine approving this issue once we add the feasibility checkboxes but we could also bring it up to Bonnie in Sunday's meeting to get clarification. You've put in a ton of work on this so I will leave it up to you.

blulady avatar Aug 11 '22 20:08 blulady

I think that the feasibility check boxes will need a text area below them for specification.

blulady avatar Aug 11 '22 20:08 blulady

Hello @blulady and @arpitapandya, I've added the drop down, but I'm not sure if the formatting is correct. Is the drop down used to generate the checklist? Or should the checklist stay there regardless of if "Yes" is selected for "Is there a dependency?" Also @arpitapandya, thank you for linking that extension! It helped me see some of the unnecessary properties I had added. Thanks for working on it! I am on call for PR's on Thursday. I hope someone reviews this before then but I will be reviewing it on Thursday if not.

  • For the dependency label my understanding is if you can make it like example form as stated in issue then an input for what it is if yes)
  • Can you move dependency after title (first title, Dependency and then Overview in order as per the issue)?
  • For the Action Items and Checklist I saw you made changes, I would love to learn from @blulady before I jump and make an assumption as I am not too sure. Again, Thanks @jdingeman for constantly following up and working on this issue by making changes.

@jdingeman I am so sorry for the misunderstanding that I misspelled and linked example form that may caused you to work more and do all changes.

  • when I referenced example form was just for the dependency label as that template form had that label. I didn't mean to make you do all changes and make that same form again, as I know you already did make correct form, just that Dependency label was missing partially.
  • I referenced as the past issue has lots of sample forms and demos created by other developers in past, which we can use as a resource for certain pieces, but I was aware that there's already resulting issue form linked to that which we're focusing on.
  • As you have worked a lot, I would leave it up to you and @blulady

arpitapandya avatar Aug 12 '22 04:08 arpitapandya

@arpitapandya no worries at all! @blulady do you mean like this? image

jdingeman avatar Aug 15 '22 02:08 jdingeman

Leaving the commented sections in to easily switch between checklist/textarea format depending on what is best suited for the issue form.

jdingeman avatar Aug 17 '22 20:08 jdingeman

@arpitapandya no worries at all! @blulady do you mean like this? image

That looks good to me. I might go with Feasibility item 1, 2, 3.

blulady avatar Aug 17 '22 20:08 blulady

I will go ahead and add the textareas. I agree with you on this.

jdingeman avatar Aug 19 '22 02:08 jdingeman