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

Contributor docs #267

Merged
merged 9 commits into from
Nov 22, 2024
Merged

Contributor docs #267

merged 9 commits into from
Nov 22, 2024

Conversation

mastoffel
Copy link
Collaborator

goals:

  • update/restructure CONTRIBUTING.md
  • add contributing-emulators.md
  • add contributing-docs.md
  • anything else?

@mastoffel mastoffel requested a review from aranas November 19, 2024 16:18
@codecov-commenter
Copy link

codecov-commenter commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.48%. Comparing base (8500aae) to head (b569b85).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #267      +/-   ##
==========================================
+ Coverage   92.46%   92.48%   +0.02%     
==========================================
  Files          62       62              
  Lines        3635     3635              
==========================================
+ Hits         3361     3362       +1     
+ Misses        274      273       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

Copy link
Contributor

github-actions bot commented Nov 19, 2024

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link
Collaborator

@aranas aranas left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for putting the work in to integrate this with the existing guides. I have added a few minor comments.
I also suggest adding a note about the limitations around adding emulators that are expecting time-series data.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/community/contributing-docs.md Outdated Show resolved Hide resolved
docs/community/contributing-emulators.md Show resolved Hide resolved
docs/community/contributing-emulators.md Outdated Show resolved Hide resolved
docs/community/contributing-emulators.md Outdated Show resolved Hide resolved
docs/community/contributing-emulators.md Outdated Show resolved Hide resolved
docs/community/contributing-emulators.md Show resolved Hide resolved
@mastoffel mastoffel marked this pull request as ready for review November 22, 2024 09:28
mastoffel and others added 8 commits November 22, 2024 10:41
add contributing-emulators doc

write contributing emulators docs

add contributing docs

update contributing emulator docs
update README
Update CONTRIBUTING.md

Co-authored-by: Sophie Arana <[email protected]>

Update CONTRIBUTING.md

Co-authored-by: Sophie Arana <[email protected]>

Update CONTRIBUTING.md

Co-authored-by: Sophie Arana <[email protected]>
Co-authored-by: Sophie Arana <[email protected]>

Update docs/community/contributing-emulators.md

Co-authored-by: Sophie Arana <[email protected]>

Update docs/community/contributing-emulators.md

Co-authored-by: Sophie Arana <[email protected]>

Update docs/community/contributing-emulators.md

Co-authored-by: Sophie Arana <[email protected]>
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@aranas
Copy link
Collaborator

aranas commented Nov 22, 2024

I am happy for this to be merged

@mastoffel mastoffel merged commit 800fd5b into main Nov 22, 2024
6 checks passed
@mastoffel mastoffel deleted the contributor-docs branch December 2, 2024 16:42
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.

3 participants