Skip to content
ScottyLabs Docs

Contributing

To contribute to a ScottyLabs project, follow the README instructions in Governance to join a team and obtain the necessary permissions.

You can join anytime of the year!

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability, and instead send an email to ops@scottylabs.org.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you’re unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description and as much relevant information as possible.

Do you have an idea for a new feature?

  • Ensure the feature was not already proposed by searching on GitHub under Issues.

  • If you’re unable to find an open issue addressing the problem, open a new one. Be sure to include a title and description of the feature you want to add.

Do you want to contribute to the codebase?

Find an Issue

Start by looking through the open issues to find something you are interested in working on. Please avoid picking issues that are already assigned to someone.

  • Look for issues labeled good first issue. These are great entry points for new contributors.

If you don’t see something that interests you, feel free to open a new issue with your idea.

Note that a new contributor won’t be assigned to the issue until their PR is merged. This helps keep issues open for others who might also want to work on them, but we will try to not assign the same issue to multiple contributors over a short period of time.

Request Permission

Follow the README instructions in Governance to join a team and obtain the necessary permissions.

When opening your Governance PR, make sure to link the corresponding issue that you will be working on.

Setup and Develop

Sign up on Codeberg if you do not have an account. That page has SSH setup and optional commit signing. Repository-specific setup is in each project’s docs.

Submit a Pull Request and Get Credited as a Contributor

See PR Process.

Do you have questions?

Ask any question in the ScottyLabs Slack by messaging in the corresponding channel or DMing any maintainer of the project. You can find information about the Slack channels and maintainers of a project in Governance.

Join Us!

We encourage you to get involved and join the team!

Thanks!

ScottyLabs Team

Acknowledgments

This document was adapted from the Ruby on Rails contributing guide.