Skip to content

Contribuiting file with links outdated #2239

@Rodrigo-Novas

Description

@Rodrigo-Novas

Is your feature request related to a problem?

It is not a problem but the documentation of the contribution file gave me some problems in understanding the rules that were proposed.

The links used in the contributing.md file had inconsistencies, for example some links were permalinks and others were not.

For cases where a specific line of code is referenced, it is always recommended to use permalinks, this gives us the possibility of having the part of code that we referred to at the exact moment of putting together the documentation.

Below I show you some examples of links that were wrong:

I change

For

with _suppress_instrumentation(_SUPPRESS_INSTRUMENTATION_KEY):

Because the implementation of suppress_instrumentation has been changed

I change

For

Describe the solution you'd like

To amend this, the links should be replaced with permalinks where they refer to a line of code, while the links that refer to files or external content should be left as a link.

Additionally, you should follow the rules that markdown proposes for your md files (I found several style rules that were not followed), a good guide is to use some markdownlint.

Some of the rules that are not followed:

Additional context

Ex1 Ex2

Some useful links:

https://www.markdownguide.org/basic-syntax/

https://github.com/orgs/community/discussions/35615#discussioncomment-3834745

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions