About
Community Guide

Community Guide

Welcome to the project’s community guide!

Support Channels

Ways of Contributing

Recipya stands as a collaborative open-source endeavor. We welcome anyone who wants to help us make this recipes manager the best it can be! Your input and contributions are vital as we work towards creating an amazing recipe management solution. Not knowing how to code is not a requirement to contribute!

The following subsections elaborate on the different ways you can contribute.

Feature Development

Please feel free to work on features that are unassigned. I also encourage you to open a feature request issue when you have ideas that may improve the software.

You are not required to implement features yourself if you feel uncomfortable. However, the process is as follows if you do wish to.

  1. Check the list of features currently requested.
  2. Select the one you want to work on.
  3. Comment that you want to fix it or send me a message in the Matrix space so that I can move the task to the in progress column in the board and assign you to it.
  4. Fork the repository if you have not done so.
  5. Implement the feature and write tests.
  6. Push the changes to your fork.
  7. Open a pull request so that I can merge your work into main.
ℹ️
Please be aware that working on a feature without opening an issue on GitHub first might lead to rejection if I believe it is not a good fit for Recipya.

Bugs

Feel free to file bugs when you discover some! Please ensure that the bug you found has not been reported in the GitHub issues before filing an issue to reduce the number of duplicates.

You are not required to fix the bug yourself if you feel uncomfortable. However, the process is as follows if you do wish to.

  1. Check the list of bugs currently filed.
  2. Select an issue you want to work on.
  3. Comment that you want to fix it or send me a message in the Matrix space so that I can move the task to the in progress column in the board and assign you to it.
  4. Fork the repository if you have not done so.
  5. Fix the bug, test it properly, and push the changes to your fork.
  6. Open a pull request so that I can merge your work into main.

Documentation

This website is the official documentation for Recipya. It is built using Hextra, which is a static site generator that is very easy to use and understand. You do not need to open an issue regarding updates to the documentation. Please feel free to update as you deem fit and open a pull request. You can help us with translations, adding a language, fixing typos, improving grammar, adding sections, updating images, versioning, etc.

To develop the documentation locally, you must first fork the project.

Then, open a command prompt or terminal and navigate to recipya/docs/website.

cd path/to/recipya/docs/website

Next, serve the website locally.

hugo serve

The website should have opened in your browser automatically at http://localhost:3000. You are now free to edit text and changes will be reflected in the browser on file save.

Helping Others

It is always great to help anyone who needs a hand. Please see the support channels for places where you could lend a hand.

Contributor Covenant Code of Conduct