Skip to content

Add optional DoScript contributor toolkit under tools/doscript/#188

Closed
TheServer-lab wants to merge 11 commits intopallets-eco:mainfrom
TheServer-lab:main
Closed

Add optional DoScript contributor toolkit under tools/doscript/#188
TheServer-lab wants to merge 11 commits intopallets-eco:mainfrom
TheServer-lab:main

Conversation

@TheServer-lab
Copy link

@TheServer-lab TheServer-lab commented Feb 18, 2026

Pull Request: Add optional DoScript contributor toolkit under tools/doscript/

Summary

This PR adds a small, optional contributor toolkit written in DoScript under tools/doscript/.
It provides safe, well‑documented helper scripts to make common contributor tasks (lint, tests, cleanup, build, quick archive) easier for people working on the repository.


Why this change?

  • Lower friction for contributors with simple one‑command workflows
  • Helps newcomers run test/lint/build without memorizing many commands
  • Strictly optional and non‑invasive — does not modify library source or CI
  • Designed to be easy to remove and low maintenance

What’s included

  • tools/doscript/README.md — maintainer‑friendly explanation and guidance

  • tools/doscript/cleanup.do — safe cleanup of caches and build artifacts

  • tools/doscript/dev-check.do — quick repo sanity checks

  • tools/doscript/make-release-zip.do — creates a zip of src/

  • tools/doscript/all.do — full contributor workflow (optional dev deps → lint → test → build → quick zip)

  • Optional helpers:

    • tools/doscript/lint.do
    • tools/doscript/test.do
    • tools/doscript/requirements-dev.txt (recommended but optional)

Files changed

A  tools/doscript/README.md
A  tools/doscript/cleanup.do
A  tools/doscript/dev-check.do
A  tools/doscript/make-release-zip.do
A  tools/doscript/all.do
A  tools/doscript/lint.do
A  tools/doscript/test.do
A  tools/doscript/requirements-dev.txt

Safety & scope

  • All files are confined to tools/doscript/ only
  • No edits to src/ or test code
  • Scripts support previewing behavior using dry‑run patterns
  • Dev dependencies are optional and handled gracefully if missing

How to review / run locally

Preview without changing anything

python doscript.py tools/doscript/cleanup.do --dry-run

Run full contributor workflow

python doscript.py tools/doscript/all.do

Run individual helpers

python doscript.py tools/doscript/dev-check.do
python doscript.py tools/doscript/lint.do
python doscript.py tools/doscript/test.do

Optional reproducible dev tools

python -m pip install -r tools/doscript/requirements-dev.txt

Acceptance checklist (for maintainers)

  • Scripts are confined to tools/doscript/
  • README clearly states toolkit is optional and removable
  • No core source or CI changes
  • Dev dependencies remain optional
  • Scripts are short, commented, and easy to inspect

Suggested branch / commit

Branch: tools/doscript-add
Commit message: Add optional DoScript contributor toolkit under tools/doscript/


Notes for maintainers

If preferred, I can:

  • Move the folder to a different location
  • Remove or simplify any scripts
  • Maintain this toolkit in a separate repository instead of in‑tree

Happy to adjust quickly based on feedback. The goal is purely to make contributor setup easier without affecting the core project.


Acknowledgement

This toolkit is intended only to help contributors and does not attempt to replace the project’s existing build or CI processes.
If changes are needed to make this more acceptable, I will update the PR promptly.


Optional: Installing DoScript

These helper scripts require DoScript.
If you don’t plan to use the scripts, no installation is needed and normal contribution workflows remain unchanged.

@davidism davidism closed this Feb 18, 2026
@pallets-eco pallets-eco temporarily blocked TheServer-lab Feb 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants