adding templates for issues

[GFMoraga]

Change Summary

Overview

Adding template for issue. Updates on algorithim_dev.md, bug_reporting.md

New Files

General_issue.md

[greglucas]

I think this content is good and the PR looks like it is pointing at the right locations!

I think we might want to use yaml formatting instead to allow for some more flexibility in how it is rendered with the boxes/text areas?

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

Can you take the content/ideas you have here and convert them over into:
algorithm_development.yml and bug_report.yml

I think this would help with some of your multi-section pieces here as well and allow drop-downs, optional sections etc...

[GFMoraga]

@greglucas what are the benefits of a .yml and is it as easy as changing the .md to .yml?

[GFMoraga]

@greglucas @tech3371 why does this not specify the whitespace? Can you help me understand this block?

trim trailing whitespace.................................................Failed

• hook id: trailing-whitespace
• exit code: 1
• files were modified by this hook

[greglucas]

@greglucas what are the benefits of a .yml and is it as easy as changing the .md to .yml?

I think that is what it takes to get the nice auto-formatting shown in that link with text-boxes etc. (i.e. GitHub has special handling of these files) But, maybe that can be done with Markdown as well? I don't know, I've just only seen other repos use yml. This is fine for a first cut and if we do want that format it can be a follow-on ticket as well.

@greglucas @tech3371 why does this not specify the whitespace? Can you help me understand this block?

All files should have a blank line at the end of them. You can also add a comment to your PR to have the bot help you out as well I think, with just this text in a new comment: pre-commit.ci autofix

[GFMoraga]

Markdown is two things: (1) a plain text formatting syntax; and (2) a software tool, written in Perl, that converts the plain text formatting to HTML. On the other hand, YAML is detailed as "A straightforward machine parsable data serialization format designed for human readability and interaction". A human-readable data-serialization language. It is commonly used for configuration files but could be used in many applications where data is being stored or transmitted.