Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/flick9000/winscript/llms.txt

Use this file to discover all available pages before exploring further.

Winscript is an open-source project licensed under the GPL v3 License, and contributions of all kinds are warmly welcomed. Whether you’re fixing a bug, proposing a new feature, or improving the documentation, the best way to contribute is through the standard fork and pull request model on GitHub. Every contribution helps make Winscript better for everyone.

​
Reporting Bugs

If you encounter unexpected behavior, please open a Bug Report on GitHub Issues. To help the team reproduce and fix the issue as quickly as possible, include the following information in your report:
  • Windows version — e.g., Windows 10 Pro 22H2 or Windows 11 Home 23H2
  • Winscript version — e.g., v2.20.2 (visible in the app title bar or on the GitHub releases page)
  • Installation type — whether you’re running an installed copy or a portable executable
  • Steps to reproduce — a clear, numbered sequence of actions that reliably triggers the bug
  • Expected behavior — what you expected the application to do
  • Actual behavior — what the application actually did, including any error messages
The more detail you provide, the faster the issue can be investigated and resolved.

​
Requesting Features

Have an idea for a new tweak, app, or workflow improvement? Open an Enhancement Request on GitHub Issues using the feature request template. Describe the feature you’d like to see, explain the use case or problem it solves, and mention any alternative approaches you’ve already considered. Clear, well-scoped requests are much easier to evaluate and prioritize.

​
Submitting Pull Requests

1

Fork the repository

Click Fork on the Winscript GitHub page to create your own copy of the repository under your GitHub account.
2

Create a feature branch

Create a dedicated branch for your changes so your work stays isolated from main:
git checkout -b feature/my-improvement
3

Make your changes

Implement your fix or feature. Keep changes focused — one logical change per pull request makes review faster and merges cleaner.
4

Commit with a descriptive message

Write a clear, concise commit message that explains what changed and why:
git commit -m "feat: add toggle for disabling Windows Search Indexing"
5

Push the branch

Push your branch to your forked repository on GitHub:
git push origin feature/my-improvement
6

Open a Pull Request

Navigate to the original Winscript repository and click New Pull Request. Select your branch, fill in the PR template (including the type of change: bugfix, feature, refactoring, etc.), and submit. A maintainer will review your PR and may request changes before merging.

​
Code of Conduct

All contributors are expected to follow the project’s Contributor Covenant Code of Conduct. In short: be respectful, demonstrate empathy toward others, give and accept constructive feedback gracefully, and focus on what is best for the community. Instances of unacceptable behavior — including harassment, personal attacks, or publishing others’ private information — can be reported to the project maintainers at contact@winscript.cc and will be reviewed promptly and fairly.

​
Support the Project

Beyond code contributions, you can support Winscript by starring the repository on GitHub to help it reach more people, or by making a small donation via Ko-Fi.

GitHub Issues

Report a bug or request a feature on the Winscript issue tracker.

GitHub Discussions

Ask questions, share ideas, and connect with the Winscript community.

Star on GitHub

Leave a star to help Winscript reach more people.

Donate on Ko-Fi

Buy the maintainer a coffee to support ongoing development.

Build docs developers (and LLMs) love

Get started for freeTalk to us