Contribution guide
Thanks for your interest in improving RunContainer. Bug reports, compatibility notes and documentation fixes are all valuable.
Where to contribute
RunContainer is free and open source. The source repository and issue tracker are public. For questions, see the Support page. Please don't rely on unofficial channels claiming to represent the project. All official links are on Community & links.
Ways to contribute
- Report bugs, such as something that doesn't work as described here.
- Report compatibility, letting others know which applications work or don't.
- Suggest features that would make RunContainer more useful.
- Improve the documentation by fixing mistakes, unclear wording or missing steps.
Bugs and feature requests go to the issue tracker. If you'd rather talk an idea or problem through first, you can also join the Discord server. Compatibility reports can go to the issue tracker too.
Reporting bugs
A useful bug report includes:
- What you did: the steps, in order.
- What you expected to happen.
- What actually happened, including the exact error message.
- Your setup: your Windows version and the RunContainer version.
- Whether it happens every time, and whether it happens in a fresh environment.
File the report on the issue tracker. Not sure it's a bug? Ask first on the Discord server.
Remove personal information
Before posting, remove usernames, email addresses, file paths containing your name, licence keys and anything else private. See Privacy & credentials.
Security vulnerabilities shouldn't be reported publicly. See Reporting security issues.
Reporting compatibility
When reporting how an application behaves in RunContainer, include:
- the application's name and version,
- where you got it (for example, the official website),
- what works and what doesn't,
- whether its installer asked for drivers, services or a restart.
Suggesting features
Describe the problem you're trying to solve, not just the solution. This makes it easier to find the best approach.
Submit the request on the issue tracker. To discuss an idea with others before you file it, join the Discord server.
Improving this website
This website is built with VitePress from Markdown files. To suggest a correction to these pages, report it in the issue tracker.
Writing guidelines:
- Describe what users see and do, not how RunContainer works internally.
- Don't promise safety, malware protection or universal compatibility.
- Mark anything unconfirmed as unconfirmed, rather than guessing.
- Keep language plain and friendly.
Code of conduct
Be respectful and constructive. Assume good intent, and help keep the project welcoming to newcomers.