openframeworks / openframeworks/projectGenerator

Clarify Project name and path

Open
#139 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
90
Forks
79
Avg merge
2d 9h
Merged PRs (30d)
5

Description

Context: Have experience with oF, use VS2015 with the oF plugin normally , new to using the project generator.

Problem: I find the project name and path combination confusing

Questions I ask myself that I can't easily answer:

  • Can project path be any path anywhere?
  • Should project path stick to the general practice of being ../../../ away from the root?
  • Will project name generate a new folder for me as well (in which case do I have to point it to ../../ away from root)? Or will it just dump files into a folder I make and then point the project path at that folder?

Possible solutions:

  • A single line below each field name that describes what is expected/best practice and what the tool will do for you. i.e. "Project name will create a folder and place your new project in it."
  • If tooltips aren't hard, maybe a small "?" icon next to the names that will have a sentence or two description of expected/best practice
  • Depending on how much a standard design process wants to be created in oF, maybe project path should already lock in/grey out the path to your "myApps" folder using the oF path in settings and only let you add a project name, which then creates the folder for you. Then there could be a possible "Expert mode" button in the settings that allows you to do whatever you like with your project path.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the project generator and inspecting the project name/path fields and settings flow described in the issue. Compare current behavior with the questions raised; done means the expected path rules and folder creation are clear in the UI, with the agreed behavior reflected in the relevant guidance.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.