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

[DOC] Adding development docs to make sure it is clear how to do dev #150

Merged
merged 3 commits into from
Oct 19, 2023

Conversation

adam2392
Copy link
Collaborator

@adam2392 adam2392 commented Oct 18, 2023

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

  • I've read and followed all steps in the Making a pull request
    section of the CONTRIBUTING docs.
  • I've updated or added any relevant docstrings following the syntax described in the
    Writing docstrings section of the CONTRIBUTING docs.
  • If this PR fixes a bug, I've added a test that will fail without my fix.
  • If this PR adds a new feature, I've added tests that sufficiently cover my new functionality.

After submitting

  • All GitHub Actions jobs for my pull request have passed.

Signed-off-by: Adam Li <adam2392@gmail.com>
Copy link
Member

@sampan501 sampan501 left a 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

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

@PSSF23 PSSF23 left a 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>
@sampan501 sampan501 self-requested a review October 18, 2023 16:09
@codecov
Copy link

codecov bot commented Oct 18, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (983b846) 89.73% compared to head (b5c3703) 89.73%.
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@sampan501 sampan501 merged commit 860d197 into main Oct 19, 2023
24 checks passed
@sampan501 sampan501 deleted the devdoc branch October 19, 2023 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants