Contributing

Name: html2rss
Author: html2rss

We’re thrilled that you’re interested in contributing to html2rss! There are many ways to get involved, and we welcome contributions of all kinds.

Code of Conduct

Before you begin, please read our Code of Conduct. We expect all contributors to adhere to this code to ensure that our community is a welcoming and inclusive space for everyone.

How to Contribute

Here are the main ways you can contribute to the html2rss project:

1. Create a Feed Config (Most Popular!)

Are you missing an RSS feed for a website? You can create your own feed config and share it with the community. It’s a great way to get started with html2rss and help other users.

The easiest way to contribute:

Go to html2rss-configs on GitHub
Click “Fork” → “Add file” → Create domain.com.yml
Paste your config → “Commit new file” → “Open pull request”

Need help writing configs? See our Creating Custom Feeds guide.

Want to test your config first? Use the Ruby gem to test it locally:

html2rss feed your-config.yml

2. Host a Public Instance

The html2rss-web project is a web application that provides RSS feeds with stable HTTPS URLs. You can host your own public instance to help other users access feeds.

Learn how to host a public instance

3. Improve the Website

This website is built with Astro and Starlight and is hosted on GitHub Pages. If you have any ideas for improving the documentation or the design, we’d love to hear from you.

Find the source code on GitHub

4. Improve the `html2rss` Engine

Are you a Ruby developer? You can help us improve the core html2rss gem. Whether you’re fixing a bug, adding a new feature, or improving the documentation, your contributions are welcome.

Check out the documentation for the html2rss Gem

5. Report Bugs & Discuss Features

If you’ve found a bug, please open an issue on the appropriate GitHub repository. For new feature ideas, we encourage you to start a discussion first.

Report Bugs:

Discuss Features:

Start a New Discussion on GitHub

We appreciate your interest in contributing to html2rss!