First off, thanks for taking the time to contribute!
All types of contributions are encouraged and valued. See the Table of Contents for the different ways to help and the details on each. Please read the relevant section before making your contribution - it makes things easier for the maintainer and smoother for everyone.
If you like the project but do not have time to contribute, that is fine. There are other easy ways to support it and show your appreciation:
- Star the project
- Post about it
- Refer to it in your own project's readme
- Mention it to friends and colleagues
This project and everyone in it is governed by the Code of Conduct. By participating, you are expected to uphold it. Report unacceptable behavior to silkterm@ubx9.com.
Before asking, search the existing issues - your question may already be answered. It is also worth a quick web search first.
If you still need clarification:
- Open an issue.
- Provide as much context as you can about what you are running into.
- Provide project and platform versions where they seem relevant.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to it, and that it may be provided under the project license.
A good bug report should not leave others chasing you for more information. Please investigate, gather what you can, and describe the issue in detail.
- Make sure you are on the latest version.
- Confirm it is really a bug and not a local misconfiguration or an incompatible environment. Re-read the documentation; for support questions see I have a question.
- Check the bug tracker to see if it has already been reported.
- Search the web to see if others outside this repo have discussed it.
- Collect the relevant details:
- OS, platform, and version (Windows, Linux, macOS; x86, ARM).
- Environment versions.
- Your input and the resulting output, where useful.
- Whether you can reliably reproduce it, and whether older versions also reproduce it.
- Clean, from-scratch reproduction steps.
Never report security issues, vulnerabilities, or bugs that include sensitive information in the public tracker. Send those by email to silkterm@ubx9.com instead.
Bugs and errors are tracked as GitHub issues. When you hit one:
- Open an issue.
- Explain the behavior you expected and the behavior you actually saw.
- Give as much context as you can, and describe the reproduction steps someone else can follow. Isolate the problem into a reduced test case where possible.
- Include the details you collected above.
Once filed, the issue will be triaged, someone will try to reproduce it from your steps, and it will be labeled and worked from there. Issues without reproduction steps may be paused until they can be reproduced.
This section covers submitting an enhancement suggestion for SilkTerm, from brand-new features to small improvements. Following it helps the maintainer and the community understand your idea and find related ones.
- Make sure you are on the latest version.
- Read the documentation to see whether the functionality already exists, perhaps via configuration.
- Search the issues to see whether it has already been suggested. If so, comment on the existing issue instead of opening a new one.
- Consider whether it fits the scope and aims of the project. Make the case for why it would be useful to most users, not just a small subset.
Enhancement suggestions are tracked as GitHub issues.
- Use a clear and descriptive title.
- Give a step-by-step description of the suggested enhancement.
- Describe the current behavior and explain the behavior you would like instead, and why. Note any alternatives you considered.
- Explain why the enhancement would be useful to most SilkTerm users. Point to other projects that solved it well, if any.
- Install the per-platform prerequisites: prerequisites.md.
- Build and run per build.md. On Linux,
cargo run --releaseis enough to get going. - Read the style guide before writing code - it is the canonical reference for naming, comments, Rust conventions, and formatting.
The canonical style reference is style-guide.md. It covers prose, comments, naming, Rust conventions, formatting, and commit messages.
Keep them brief and high-level - a short summary of what changed. Put real detail in the issue, the pull request, or the code. See the commit messages section of the style guide.
This guide is based on the contributing.md generator.