Project Ideas

[CyberStrike]

Discussions and planning on project idea proposals and templates. Carried over from CodeforSouth/project-ideas#4

[CyberStrike]

issue-template.md is template file for a repos issues described in Creating an issue template for your repository.

In the scope of Code-for-Miami/project-ideas and that repository only, issue === project idea or in English;Project Ideas are posted as issues on the Code-for-Miami/ project-ideas and therefore synonymous with one another.

1. I am proposing that we can leverage the templating function to include a required minimal amount of information we deem necessary and the maximum of information that would be nice to have as part of the issue-template.

2. I think about 1/3 of Project Idea Template should be required and the other nice to have and should be labeled as such.

3. The information in Project Idea Template or information really close to it should be made a mandatory section of the docs in every project, maybe a docs/project_details.md document.

[FrancoB411]

It seems there are a few distinct ideas here.

1. Contribution guidelines
2. Issue-templates
3. Proposing a new project

According to the GitHub docs, when a repo is properly configured:
An issue-template file will enable a template to appear when people submit an issue
A "contributing file", displays contribution guidelines when people submit PRs for a project.

Contribution guidelines can contain links. So how about we...

1. Set up an issue-template to helps people submit issues
2. Set up a project-ideas template to help people submit new project ideas
3. Include links to the issue and project-idea templates in the contribution guidelines.

Because "Issue" is overloaded, the contribution guidelines can define it in this context.

Continuing this line of thought, why not merge some repos?
"Project-ideas" and the "new member guide" could be a "User-guide" for engaging with Code for Miami.
This single source of truth can make it easier for people to find their way around.

Thoughts?

[CyberStrike]

Just to be clear we are only talking about Code-for-Miami/project-ideas and not all projects.

They are no other types of issues going to be posted in Code-for-Miami/project-ideas other than project ideas. With that in mind I don't we need to work hard to make a distinction.

If the included additional information on submitting a project idea to Code-for-Miami/project-ideas is longer than a paragraph it would make sense to add it to a contributing.md. If I can find time today to the make a branch with an example I will follow up here.

---

Continuing this line of thought, why not merge some repos?
"Project-ideas" and the "new member guide" could be a "User-guide" for engaging with Code for Miami.
This single source of truth can make it easier for people to find their way around.

Thoughts?

Scope creep! We should take this conversation to another issue.