grafana/contribute/backend
Joseph Perez eee66882ef
Docs: Edit of files in the backend contributor guide (part 7 of doc quality improvement project) (#89974)
* Docs: Edit of multiple files in the backend contributor guide (part 7 of doc quality improvement project)

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/package-hierarchy.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/package-hierarchy.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/services.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/services.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/services.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/package-hierarchy.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/services.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Fix for active voice

* Update contribute/backend/instrumentation.md

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update contribute/backend/instrumentation.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Fix from review

* Update contribute/backend/services.md

* Update contribute/backend/services.md

* Spelling of wire

* Prettier fixes

* Minor fix

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2024-07-29 06:06:50 -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 Docs: Edit of files in the backend contributor guide (part 7 of doc quality improvement project) (#89974) 2024-07-29 06:06:50 -07:00
package-hierarchy.md Docs: Edit of files in the backend contributor guide (part 7 of doc quality improvement project) (#89974) 2024-07-29 06:06:50 -07: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 Docs: Edit of files in the backend contributor guide (part 7 of doc quality improvement project) (#89974) 2024-07-29 06:06:50 -07: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.