Remove CONTRIBUTING-SCRIPTS doc

This commit is contained in:
rcourtman 2025-11-13 22:34:21 +00:00
parent 70673c1fdc
commit 6d591920d9
3 changed files with 1 additions and 57 deletions

View file

@ -1,52 +0,0 @@
# Contributing to Pulse Installer Scripts
## Workflow Overview
1. **Plan** the change (refactor, new feature, bugfix) and confirm whether the
shared libraries already support your needs.
2. **Implement** in the modular source file (e.g., `scripts/install-foo-v2.sh`).
3. **Add/Update tests** (smoke + integration where applicable).
4. **Bundle** (`make bundle-scripts`) and verify outputs.
5. **Document** any behavioural changes.
6. **Submit PR** with summary, testing results, and rollout considerations.
## Expectations
- Use shared libraries (`scripts/lib/*.sh`) instead of duplicating helpers.
- Maintain backward compatibility; introduce feature flags when needed.
- Keep legacy script versions until rollout completes.
- Ensure `scripts/tests/run.sh` (smoke) and relevant integration tests pass.
- Run `make lint-scripts` (shellcheck) before submitting.
- Update `scripts/bundle.manifest` and regenerate bundles.
- Provide before/after metrics when refactoring (size reduction, test coverage).
## Testing Checklist
- `scripts/tests/run.sh`
- `scripts/tests/test-sensor-proxy-http.sh` (requires Docker; validates uninstall → HTTP install cycle)
- Relevant `scripts/tests/integration/*` scripts (add new ones if needed)
- Manual `--dry-run` invocation of the script when feasible
- Bundle validation: `bash -n dist/<script>.sh` and `dist/<script>.sh --dry-run`
## Useful Commands
```bash
# Lint & format
make lint-scripts
# Run smoke tests
scripts/tests/run.sh
# Run integration tests
scripts/tests/integration/test-<name>.sh
# Rebuild bundles
make bundle-scripts
```
## Resources
- `docs/script-library-guide.md` — detailed patterns and examples
- `scripts/lib/README.md` — library function reference
- `docs/installer-v2-rollout.md` — rollout process for installers
- GitHub Discussions / internal Slack for questions

View file

@ -48,7 +48,6 @@ section groups related guides so you can jump straight to the material you need.
## Development & Contribution
- [CONTRIBUTING.md](../CONTRIBUTING.md) Repository-wide contribution guide.
- [CONTRIBUTING-SCRIPTS.md](CONTRIBUTING-SCRIPTS.md) Expectations for installer contributors.
- [script-library-guide.md](script-library-guide.md) Working with shared Bash modules.
- [installer-v2-rollout.md](installer-v2-rollout.md) Process for shipping major installer updates.
- [development/MOCK_MODE.md](development/MOCK_MODE.md) Using mock data while developing.
@ -56,4 +55,3 @@ section groups related guides so you can jump straight to the material you need.
Have an idea for a new guide? Update this index when you add documentation so
discoverability stays high.

View file

@ -58,8 +58,7 @@ checks in the tracking issue.
- Refresh quick-start snippets in `README.md`.
- Note behavioural changes in `docs/RELEASE_NOTES.md` under the relevant
version once the rollout ships.
- For script contributors, update `docs/CONTRIBUTING-SCRIPTS.md` and
`docs/script-library-guide.md` with new patterns.
- Keep `docs/script-library-guide.md` aligned with any new patterns so future tweaks stay consistent with the rollout plan.
---
@ -94,4 +93,3 @@ the v1 flag available for at least one stable release.
Keeping this playbook up to date ensures future installer iterations follow the
same predictable rollout process and reduces duplicate tribal knowledge.