Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(guidelines): add dependencies guidelines #4040

Merged
merged 20 commits into from
Aug 23, 2023

Conversation

haddasbronfman
Copy link
Member

Which problem is this PR solving?

After reading the discussion on #3847 and consulting other maintainers, I thought it would be good to write dependency guidelines.

Short description of the changes

Add GUIDELINES.md file. Currently contain only dependency guidelines.

@haddasbronfman haddasbronfman requested a review from a team August 5, 2023 22:48
@codecov
Copy link

codecov bot commented Aug 5, 2023

Codecov Report

Merging #4040 (2a3a684) into main (5259a0b) will decrease coverage by 1.86%.
The diff coverage is n/a.

❗ Current head 2a3a684 differs from pull request most recent head 04358a3. Consider uploading reports for the commit 04358a3 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4040      +/-   ##
==========================================
- Coverage   92.37%   90.52%   -1.86%     
==========================================
  Files         321      159     -162     
  Lines        9273     3756    -5517     
  Branches     1970      835    -1135     
==========================================
- Hits         8566     3400    -5166     
+ Misses        707      356     -351     

see 167 files with indirect coverage changes

Copy link
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this 🙂
I've made some suggestions, no need to apply them all, feel free to change and adapt what fits 🙂

GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
Copy link
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of this 🙂

GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
Copy link
Member

@legendecas legendecas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The guidelines look good to me!

However, we have lots of files in the root directory already. It might be a good alternative to put the guideline in https://github.com/open-telemetry/opentelemetry-js/tree/main/doc.

@dyladan dyladan merged commit f263ab7 into open-telemetry:main Aug 23, 2023
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants