docs: init docs
All checks were successful
Build and Release / Build (darwin-arm64) (push) Successful in 19s
Build and Release / Build (darwin-amd64) (push) Successful in 20s
Build and Release / Build (linux-arm64) (push) Successful in 17s
Build and Release / Build (linux-amd64) (push) Successful in 20s
Build and Release / Build (windows-arm64) (push) Successful in 16s
Build and Release / Build (windows-amd64) (push) Successful in 19s
Build and Release / Create Release (push) Has been skipped
Deploy docs / deploy (push) Successful in 45s
All checks were successful
Build and Release / Build (darwin-arm64) (push) Successful in 19s
Build and Release / Build (darwin-amd64) (push) Successful in 20s
Build and Release / Build (linux-arm64) (push) Successful in 17s
Build and Release / Build (linux-amd64) (push) Successful in 20s
Build and Release / Build (windows-arm64) (push) Successful in 16s
Build and Release / Build (windows-amd64) (push) Successful in 19s
Build and Release / Create Release (push) Has been skipped
Deploy docs / deploy (push) Successful in 45s
This commit is contained in:
parent
ba66894e42
commit
deae4a6272
20 changed files with 2887 additions and 1 deletions
82
docs/feedback.md
Normal file
82
docs/feedback.md
Normal file
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
title: Provide Feedback
|
||||
description: Help improve Sub-CLI by sharing your experience and suggestions
|
||||
---
|
||||
|
||||
# Provide Feedback
|
||||
|
||||
Your feedback is invaluable to the continued development and improvement of Sub-CLI. We welcome all types of feedback, including bug reports, feature requests, usability suggestions, and general comments.
|
||||
|
||||
## Ways to Provide Feedback
|
||||
|
||||
### Issues
|
||||
|
||||
The best way to report bugs or request features is through our issue tracker:
|
||||
|
||||
1. Visit the [Sub-CLI Issues](https://git.owu.one/wholetrans/sub-cli/issues) page
|
||||
2. Click on "New Issue"
|
||||
3. Provide as much detail as possible
|
||||
4. Submit the issue
|
||||
|
||||
### Email
|
||||
|
||||
If you prefer, you can send feedback directly via email to:
|
||||
|
||||
`hello@wholetrans.org` (example email)
|
||||
|
||||
### Community Channels
|
||||
|
||||
Join our community to discuss Sub-CLI, share your experience, and get help:
|
||||
|
||||
::: info
|
||||
|
||||
Currently there's no dedicated channel for Sub-CLI. You can join our `#general` room for general questions and discussions.
|
||||
|
||||
:::
|
||||
|
||||
- Matrix Space: [#wholetrans:mtx.owu.one](https://matrix.to/room/#wholetrans:mtx.owu.one)
|
||||
|
||||
You can find more contact information in our [About](https://wholetrans.org/about) page.
|
||||
|
||||
|
||||
## Reporting Bugs
|
||||
|
||||
When reporting bugs, please include:
|
||||
|
||||
1. **Sub-CLI Version**: Output of `sub-cli version`
|
||||
2. **Operating System**: Your OS name and version
|
||||
3. **Steps to Reproduce**: Detailed steps to reproduce the issue
|
||||
4. **Expected Behavior**: What you expected to happen
|
||||
5. **Actual Behavior**: What actually happened
|
||||
6. **Additional Context**: Any other relevant information, such as command output, error messages, or screenshots
|
||||
|
||||
## Feature Requests
|
||||
|
||||
When requesting new features, please include:
|
||||
|
||||
1. **Use Case**: Describe the specific scenario or problem you're trying to solve
|
||||
2. **Proposed Solution**: Your idea for implementing the feature
|
||||
3. **Alternatives Considered**: Any alternative solutions you've considered
|
||||
4. **Additional Context**: Any other relevant information that might help us understand the request
|
||||
|
||||
## Contribution Guidelines
|
||||
|
||||
Interested in contributing to Sub-CLI? We welcome contributions of all kinds, from code improvements to documentation updates.
|
||||
|
||||
### Code Contributions
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch
|
||||
3. Make your changes
|
||||
4. Submit a pull request
|
||||
|
||||
### Documentation Contributions
|
||||
|
||||
Found an error or omission in our documentation? Have an idea for improvement? We welcome:
|
||||
|
||||
- Documentation fixes and improvements
|
||||
- Examples and tutorials
|
||||
|
||||
## Thank You!
|
||||
|
||||
Your feedback and contributions help make Sub-CLI better for everyone. We appreciate your time and effort in helping us improve the tool.
|
Loading…
Add table
Add a link
Reference in a new issue