Separate Development Tools from the Development Guide
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation, tooling
Research direction
Start by reviewing the tools in project_setup/scripts and the testing discussion in issue #31. Compare the current development-guide structure with the proposed Python-package approach and the cisagov/skeleton-python-library reference. Done means the development tools are separated from the guide into an installable package, with the scripts available through the documented pip installation example.
Written by the indexing model from the issue text.
Description
🚀 Feature Proposal
Separate the Development Tools currently stored in project_setup/scripts into their own repository as a Python package.
Motivation
@hillaryj created an issue to add testing to the scripts in the above mentioned directory in #31 , but I believe it would be better to separate tooling from documentation.
Example
One would be able to install the development tools as a Python package a la pip install git+https://github.com/cisagov/development-tools.git and the scripts would be available in the environment.
Pitch
As it stands it is difficult to add testing and keep Python related skeleton updates current in this project because:
- It descends from cisagov/skeleton-generic instead of cisagov/skeleton-python-library
- It is a repository trying to store both documentation about our development process and the tools that are used
Moving the tooling into its own repository would allow it to be configured as a typical Python package, which would allow for our CI/CD pipeline to be implemented as it typically would for such a project. This will make it easier to add new tooling, eliminate duplicate code between tools, and ensure that testing is done automatically.
- Dominant language
- Python
- Stars
- 284
- Forks
- 71
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cisagov/development-guide
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
cisagov/development-guide#125 ·
-
documentation improvement
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
cisagov/development-guide#100 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
cisagov/development-guide#58 · 1 reaction ·
-
documentation improvement
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
cisagov/development-guide#51 · 1 reaction ·
-
improvement
Difficulty 5/5 Over a week Newbie friendliness 35/100
cisagov/development-guide#126 · 1 comment ·
All issues in cisagov/development-guide
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
SpikeInterface/spikeinterface#4924 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
aws-samples/sample-per-model-bedrock#782 ·
Maintainers usually reply within 1 day
-
bug javascript
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
No-op PreToolUse:Bash hook (bash_hook.py) still registered synchronously; adds latency and can time out at 10 sPossibly taken @alexgr-agent claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
alexgreensh/token-optimizer#313 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100