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

Improve documentation for contributors #723

Merged
merged 7 commits into from
Nov 20, 2024
Merged

Improve documentation for contributors #723

merged 7 commits into from
Nov 20, 2024

Conversation

olethanh
Copy link
Collaborator

Split of from #719, to improve reviewability.

Document how to do the developer setup.

Copy link

codecov bot commented Nov 18, 2024

Codecov Report

Attention: Patch coverage is 25.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 62.56%. Comparing base (4d319f0) to head (9e444d2).
Report is 7 commits behind head on main.

Files with missing lines Patch % Lines
tests/supervisor/test_instance.py 0.00% 1 Missing and 1 partial ⚠️
src/aleph/vm/models.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #723      +/-   ##
==========================================
- Coverage   62.57%   62.56%   -0.01%     
==========================================
  Files          70       70              
  Lines        6233     6235       +2     
  Branches      503      503              
==========================================
+ Hits         3900     3901       +1     
- Misses       2180     2181       +1     
  Partials      153      153              

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


🚨 Try these New Features:

Copy link
Collaborator

@Psycojoker Psycojoker left a comment

Choose a reason for hiding this comment

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

LGTM in general, I've just added a few typos fixes and suggestions.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
TESTING.md Outdated Show resolved Hide resolved
@olethanh olethanh merged commit f1bad18 into main Nov 20, 2024
20 of 22 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.

2 participants