grafana/contribute/backend
Joseph Perez 0ecff76600
Docs: Edit of several Backend topics (part 5 of doc quality project) (#89073)
* Edit of several Backend topics (part 5 of doc quality project)

* Proofread of files

* Prettier fix

* Update contribute/backend/upgrading-dependencies.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update contribute/backend/README.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update contribute/backend/README.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update contribute/backend/recommended-practices.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update contribute/backend/recommended-practices.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update contribute/backend/recommended-practices.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update contribute/backend/recommended-practices.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update contribute/backend/recommended-practices.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update contribute/backend/recommended-practices.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Rename doc filenames with gerunds

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-07-13 10:37:47 -07:00
..
communication.md Docs: Edit of 3 files in backend contributor guide (part 6 of doc quality improvement project) (#89582) 2024-06-25 12:28:22 -07:00
database.md Docs: Edit of 3 files in backend contributor guide (part 6 of doc quality improvement project) (#89582) 2024-06-25 12:28:22 -07:00
errors.md Docs: Edit of 3 files in backend contributor guide (part 6 of doc quality improvement project) (#89582) 2024-06-25 12:28:22 -07:00
instrumentation.md Tracing: Various improvements (#88308) 2024-05-27 14:21:40 +02:00
package-hierarchy.md Chore: Move all backend contribution documents to a single directory (#61140) 2023-01-11 11:16:52 +01:00
README.md Docs: Edit of several Backend topics (part 5 of doc quality project) (#89073) 2024-07-13 10:37:47 -07:00
recommended-practices.md Docs: Edit of several Backend topics (part 5 of doc quality project) (#89073) 2024-07-13 10:37:47 -07:00
services.md Chore: Move backgroundsvcs and usagestatssvcs to registry (#72692) 2023-08-02 09:25:55 -04:00
style-guide.md Сorrection of spelling errors (#83565) 2024-03-01 11:00:15 +01:00
support-bundles.md Docs: Edit of several Backend topics (part 5 of doc quality project) (#89073) 2024-07-13 10:37:47 -07:00
upgrade-dependencies.md Docs: Edit of several Backend topics (part 5 of doc quality project) (#89073) 2024-07-13 10:37:47 -07:00
upgrade-go-version.md Docs: Edit of several Backend topics (part 5 of doc quality project) (#89073) 2024-07-13 10:37:47 -07:00

Backend

The contribution guidelines for Grafana backend developers contain a lot of information for anyone who wants to contribute to our open source project. But you don't necessarily have to read all of it, so long as you read what is most relevant to you.

Guidelines everyone should read

We recommend that all contributors read the backend style guide to get a sense for how we try to ensure that the Grafana codebase is consistent and accessible. The rest of the backend contributor documentation tends to be more relevant to reviewers and contributors who want to make changes of greater size or quantity.

Guidelines specifically for backend developers

For anyone who reviews code for the Grafana backend, get a basic understanding of the content of the following files:

Guidelines for contributors who make or review large changes to the backend

If you want to make or review large changes to the backend, be sure to habitually familiarize yourself with the entire contents of /contribute/backend from time to time.

Guidelines for dependency management

If you work with a dependency that requires an upgrade, refer to Upgrading dependencies.