mnahkies/openapi-code-generator

require clean git working directory by default

Open

#52 opened on Apr 22, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (9 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (34 stars)
PR merge metrics
 (PR metrics pending)

Description

we don't want to accidentally overwrite peoples work

  • bail out if output directory is a git repo and there are uncommitted changes
  • add flag to override this behavior

Contributor guide

Research direction
Understand how the current code generator works, locate where output is written, and add a git dirty check before writing files. Use `git status porcelain` to check for uncommitted changes. Add a ` force` flag to override the check.
Tech stack
typescript
Domain
clibackenddeveloper experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70