Skip to content

Scripts_README.md

Latest commit

 

History

History
30 lines (23 loc) · 1.7 KB

Scripts_README.md

File metadata and controls

30 lines (23 loc) · 1.7 KB

Scripts Directory README

This directory contains scripts and related resources for various languages and tools used in this project. Please follow the guidelines below when contributing or modifying scripts.

Rules

  • Organize scripts by language or tool in their respective subfolders (e.g., python/, go/, java/).
  • Use clear, descriptive filenames and add comments to explain script functionality.
  • Test scripts before submitting a pull request.
  • Keep scripts cross-platform where possible (e.g., provide both .sh and .ps1 for shell scripts).
  • Do not include sensitive information (passwords, API keys, etc.) in any script.
  • Update this README with any new contributions or changes.

TODOs

  • Add more automation scripts for common developer tasks.
  • Improve documentation for each script and subfolder.
  • Add usage examples for each script.
  • Review and refactor existing scripts for consistency.

Contributed List

Script/Folder Description Contributed By
python/install_python.sh Installs Python on Unix systems (Add your name)
python/install_python.ps1 Installs Python on Windows systems (Add your name)
... ... ...

Please update this table when you add or modify scripts. Include what you contributed and your name or GitHub handle.

Note

If you have completed a script and want to enhance the user experience, you are encouraged to also contribute to the UI in the src/ directory. This helps integrate scripts with the main application and provides a better workflow for users.