Contribution Guidelines

Contributors are the lifeblood of the project. We welcome contributions but remind everyone to be a Gracious Professional.

Creating a PR

PRs should be made to the FTC Docs repo on GitHub. Your title should aim to describe the purpose of your PR in a concise manner. For more information on creating a PR, see this

Creating an Issue

There are two types of issues: bugs and feature requests. A bug report is an issue that describes a problem with the documentation. A feature request is an issue that describes a new feature that should be added to the documentation. Before creating either make sure to check for duplicates. If you find a duplicate, comment on the issue and add your input where possible. If possible we would love to see a PR that fixes the issue. If you are unsure how to fix the issue that is perfectly alright.

Bug Reports

  • A description of the bug

  • Expected behavior

  • Steps to reproduce the bug (If applicable)

  • Screenshots (If applicable)

Feature Requests

  • A description of the feature

  • Why you think this feature should be added

  • Screenshots (If applicable)

Colophon

FTC Docs is built with Sphinx using a theme provided by Read the Docs.

The Dark theme is provided by the FTC Docs development team.