Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (32 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.58 KB
Raw

Contributing to X Scripts

Thanks for helping improve x, the script repository used to configure and refresh X environments.

How to Contribute

  1. Fork the repository and create a branch from main.
  2. Make focused changes (one feature/fix per pull request).
  3. Test scripts on the target platform (Linux distro and/or WSL).
  4. Open a pull request with clear context, steps to test, and rollback notes if relevant.

Repository Focus

  • x.sh: base post-boot setup and environment refresh script.
  • scripts/: optional modular add-ons.
  • wsl/: setup and install scripts for WSL environments.

Contribution Rules

  • Keep scripts idempotent when possible (safe to run more than once).
  • Prefer explicit checks before system modifications.
  • Document new behavior in README.md or module readmes.
  • Never commit secrets, tokens, private keys, or machine-specific credentials.
  • For vulnerability reports, use SECURITY.md instead of public issues.

Community Behavior

By participating, you agree to follow CODE_OF_CONDUCT.md.

We appreciate every improvement to X scripts.