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 #246

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Docs #246

wants to merge 6 commits into from

Conversation

cc-a
Copy link
Contributor

@cc-a cc-a commented Nov 27, 2024

Description

This PR adds developer documentation for the project. As I'm looking to step back from leading the project this is a great time to ask any questions you may have about Dune or the development setup or just about anything so we can record it now.

Fixes: #210 #211 #212 #173

Type of change

  • Documentation (non-breaking change that adds or improves the documentation)
  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass (eg. python -m pytest)
  • The documentation builds and looks OK (eg. python -m sphinx -b html docs docs/build)
  • Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

# Conflicts:
#	README.md
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.49%. Comparing base (b9845f1) to head (f92da0d).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #246      +/-   ##
==========================================
- Coverage   82.04%   81.49%   -0.56%     
==========================================
  Files          34       33       -1     
  Lines         440      416      -24     
==========================================
- Hits          361      339      -22     
+ Misses         79       77       -2     

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants