3bcba4976a
- Introduce 'workon' as the top queued item for bootstrapping new features - Rearrange other queued items (e.g., cnotes, make, rg) and mark some as optional - Remove TODO_ITEM template from queued list - Expand workon.md with detailed description, usage, assumptions, and benefits
29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
# `grokkit workon`
|
|
|
|
**Description**: Automates the initiation of new feature and fix development.
|
|
|
|
1. selects a todo item out of the todo queue;
|
|
2. creates a branch based on the item;
|
|
3. generates a plan for implementation;
|
|
4. commits the plan to the branch;
|
|
4. logs the beginning of the work using `cnadd` (if available).
|
|
5. opens the branch in the IDE (specified in the config).
|
|
|
|
**Usage**:
|
|
```
|
|
grokkit workon <todo_item_title> [-c <custom_commit_message>]
|
|
```
|
|
|
|
**Assumptions**:
|
|
|
|
Grokkit is being customized to suit my own development workflow. So, there are a number of features that may not be translatable to other developers' habits. As such, this feature assumes that the repository has a "todo" folder with a "queued", "doing" and "completed" subfolder, that function as the in-situ ticketing system. If the "todo" folder is not present, grokkit will create it.
|
|
|
|
Also, if no IDE is specified in the config, the feature will default to not opening the editor. If `cnadd` is not available, the feature will default to not logging the beginning of the work.
|
|
|
|
**Benefits**:
|
|
|
|
1. Boosts productivity by automating routine tasks.
|
|
|
|
**High-level implementation**:
|
|
|
|
1. TBD |