FreshRSS/docs/en/contributing.md

Contributor Guidelines

Report a bug

Have you found a bug? Don’t panic, here are some steps to report it with ease:

1. Search for it on the bug tracker (don’t forget to use the search bar).
2. If you find a similar bug, don’t hesitate to post a comment to add more importance to the related ticket.
3. If you didn’t find it, open a new ticket.

If you have to create a new ticket, please try to keep in mind the following advice:

• Give an explicit title to the ticket so it will be easier to find it later.
• Be as exhaustive as possible in the description: what did you do? What is the bug? What are the steps to reproduce the bug?

We also need some information:

• Your FreshRSS version (on the about page or in the constants.php file)
• Your server configuration: the type of hosting and the PHP version
• Your storage system (SQLite, MySQL, MariaDB, PostgreSQL)
• If possible, the related logs (PHP logs and FreshRSS logs under data/users/your_user/log.txt)

For a more detailed guide on writing bug reports, please refer to the in-depth guide on reporting bugs.

Fix a bug

Would you like to fix a bug? For optimum coordination between collaborators, you should follow these indications:

1. Be sure the bug is associated with a ticket and indicate that you’ll work on it.
2. Fork the project repository.
3. Create a new branch. The name of the branch should be clear, and ideally prefixed by the related ticket id. For instance, 783-contributing-file to fix ticket #783.
4. Make your changes to your fork and send a pull request.

If you have to write code, please follow our coding style recommendations.

Tip: if you’re searching for easy-to-fix bugs, please have a look at the “good first issue” ticket label.

Submit an idea

You have great ideas, yes! Don’t be shy and open a new ticket on our bug tracker to ask if we can implement it. The greatest ideas often come from the shyest suggestions!

If your idea is nice, we’ll have a look at it.

Contribute to internationalization (i18n)

Learn how to contribute to translations in the dedicated documentation.

Contribute to the documentation

The documentation needs a lot of improvements in order to be more useful to new contributors and we are working on it. If you want to give some help, meet us in the main repositories docs directory!

Contribute to the system themes

FreshRSS offers some official themes. If you have a good sense for great UI you are invited to share your theme with the community (via a show&tell discussion thread or as a Pull Request).

Check the basic information for creating a new theme.

This checklist is designed to ensure high-quality system themes while minimizing maintenance efforts.

• Essential files include: metadata.json, loader.gif, original.png (located in the thumbs directory).
• Include _frss.css in the "files" section of metadata.json.
• Theme-specific icons reside in the icons directory.
  • Icons should be provided as svg files.
    • Ensure clean code without any unnecessary fragments; utilize tools like SVGOMG for cleaning.
    • The default color for icons is #666666; employ CSS filters for recoloring.
• Utilize CSS variables for colors to facilitate easy color adjustments with CustomCSS extension.
• Implement a dark mode that aligns with the .darkMode CSS class.
• To streamline maintenance, avoid using CSS preprocessors; instead, employ well-structured plain CSS.