blue-oil/blueoil

The contents of keep_me.md should be placed at right place

Open

#937 opened on Mar 19, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (250 stars) (85 forks)batch import
good first issue

Description

blueoil/converter/templates/debug/keep_me.md includes information about -dbg flag for generate_project.py. It should be placed at right place.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Identify the correct location for the content about the ` dbg` flag for `generate project.py`. The content currently resides in blueoil/converter/templates/debug/keep me.md. Check the project documentation structure and possibly related files like generate project.py to find where the flag information should be documented. Move the content accordingly and update any references.