Skip to content

Contributing

Welcome!

First of all, thank you for being interested in contributing to the TACO GraphQL API! This document contains guidelines to help you become an effective contributor.

How to Contribute

You can contribute in several ways:

  • Reporting bugs
  • Suggesting improvements
  • Writing or improving documentation
  • Submitting pull requests

Reporting Bugs

Before reporting a bug, please check if it has already been reported. If not, create a new issue explaining:

  • The expected behavior
  • The observed behavior
  • Steps to reproduce the bug

Suggesting Improvements

New ideas are always welcome. Open a discussion in the discussions tab on Github describing your suggestion and how it can improve the project.

Documentation

Documentation is crucial to understanding a project. If you notice a lack of documentation or errors, feel free to correct or add.

Submitting Pull Requests

Follow these steps to submit a pull request:

  1. Fork the project and create a new branch for your changes.
  2. Make your changes and write tests when applicable.
  3. Follow the project’s coding conventions.
  4. Update the documentation if necessary.
  5. Submit a pull request describing the proposed changes.

Review Process

Each contribution will be reviewed by me. I may ask for changes or give suggestions.

Questions

If you have any questions, visit the frequently asked questions page. If your question is not there, open a new discussion in the discussions tab.

Thank you for contributing to the project!