Skip to content

Project Ideas Template

Josh Branchaud edited this page Apr 7, 2014 · 4 revisions

When submitting an issue to this repository to suggest a project idea, you should follow this template. Each project idea submission should contain:

  • Project name (generally 4 words or less)
  • Base project description (generally 1 to 3 sentences)
  • Extra project description and details (optional, include this if part of the base description may be unclear or if there are details and constraints important to the problem that don't belong in the base description)
  • Sample Input and Output (optional, if it aids understanding of the problem, include a sample input and output that the solution should satisfy)
  • Any interesting extensions to the project that the user can attempt after solving the base project (optional)
  • List of possible categories (e.g. [Numbers,Math,Big Data])
  • Resources (links to any relevant resources for understanding the problem)
  • Sources (if the problem came from somewhere besides your brain, link to it here)

The following is a template based on the above description that you can copy and paste into an issue:

Note: the issue name should match the project name and the issue should include the project idea tag.

- Project Name: 
- Base Description: 
- Extra Description: 

- Sample Input/Output: *optional* 
- Extensions: *optional* 

- Categories: `Numbers`,`Math`,`Big Data` 
- Resources: 
- Sources: 
Clone this wiki locally