-
-
Notifications
You must be signed in to change notification settings - Fork 14
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
[DOC] Adding development docs to make sure it is clear how to do dev #150
Conversation
Signed-off-by: Adam Li <adam2392@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few minor comments, but otherwise we should be good to merge
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For some reason the commands 2 & 3 in the last section are not rendered as code, but the new doc looks good.
Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #150 +/- ##
=======================================
Coverage 89.73% 89.73%
=======================================
Files 41 41
Lines 3352 3352
=======================================
Hits 3008 3008
Misses 344 344 ☔ View full report in Codecov by Sentry. |
Currently, it is unclear sometimes how to setup, or carry out development locally. This document seeks to address this.
Please let me know if this addresses any confusion you have had, or have.
Here is the file rendered for your ease-of-review: https://github.com/neurodata/scikit-tree/blob/e1aafe47cb266e6fa74cab5ef6093a2cd4d60942/DEVELOPING.md
Before submitting
section of the
CONTRIBUTING
docs.Writing docstrings section of the
CONTRIBUTING
docs.After submitting