mirror of
https://github.com/tt-rss/tt-rss.github.io.git
synced 2026-10-19 13:42:47 +00:00
supahgreg
34 lines
1.5 KiB
Markdown
34 lines
1.5 KiB
Markdown
# Contributing to tt-rss Documentation
|
|
|
|
Thank you for your interest in contributing to the Tiny Tiny RSS documentation!
|
|
|
|
## How to Contribute
|
|
|
|
* Contributions (documentation corrections/improvements, reporting issues, etc.) are welcome.
|
|
* Development and issue tracking for tt-rss primarily happens at [https://github.com/tt-rss/tt-rss](https://github.com/tt-rss/tt-rss).
|
|
|
|
## Documentation License
|
|
|
|
By contributing to this repository, you agree that your contributions will be licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)](LICENSE).
|
|
|
|
This means:
|
|
- Your contributions can be freely shared and adapted by others
|
|
- Proper attribution will be given
|
|
- Derivative works must be shared under the same license
|
|
|
|
## Guidelines
|
|
|
|
When contributing documentation:
|
|
|
|
1. **Be clear and concise** - Write for users of all skill levels
|
|
2. **Test your examples** - Ensure code snippets and commands work as described
|
|
3. **Cite sources** - If including third-party content, state its source and license in your pull request
|
|
4. **Stay current** - tt-rss follows a continuous development model on the `main` branch, so the documentation needs to be kept current
|
|
5. **Check formatting** - Use proper Markdown formatting and verify links work
|
|
|
|
## Questions?
|
|
|
|
If you're unsure about including third-party content or have questions about licensing, please ask in your pull request or open a discussion.
|
|
|
|
Thank you for helping improve tt-rss documentation!
|