Contributing to Telescope
We are all eager to work on telescope, and this document will help you to get started!
For community discussions, join our #telescope Slack channel.
Before creating an issue:
- Please look through the MVP Features listed below for inspiration.
- Check open issues. Someone else may be working on the same thing!
- If they are, reach out and try to help.
- Use our Labels to help others quickly understand what an issue is all about.
Telescope has many parts, and setup requires you to install a number of tools and dependencies. For instructions on how to setup your Telescope environment, please see the Environment Setup documentation.
Telescope uses quite a few different technologies, and we have some project specific docs available for each, including our:
- database Redis
- frontend framework GatsbyJS
- frontend query language GraphQL
- single-sign-on (SSO) login using SAML2
- backend logging framework Pino
If you're unsure about how something works, talk to one of us on #telescope Slack channel.
Workflow in Git and GitHub
We use a number of tools and automated processes to help make it easier for everyone to collaborate on Telescope. This includes things like auto-formatting code, linting, and automated testing. We also use git and GitHub in particular ways.
For more information on working with our tools and our workflows, see our Git Workflow documentation.
We have a number of automated reports and audits that can be run on the code. These include things like checking accessibility and performance issues in our frontend, and determining test coverage for our automated tests.
For more information on working with these automated reports, see our Reports documentation.
When doing a release of Telescope, a number of steps must be done. To help our maintainers do this properly, we have tools and information in our Release documentation.