-
Notifications
You must be signed in to change notification settings - Fork 95
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] Update CONTRIBUTING and README with developer installation, contributing and testing instructions #375
Conversation
…teps to test readability
Codecov Report
@@ Coverage Diff @@
## master #375 +/- ##
=======================================
Coverage 79.74% 79.74%
=======================================
Files 40 40
Lines 2236 2236
=======================================
Hits 1783 1783
Misses 453 453 Continue to review full report at Codecov.
|
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.
Just add the small correction from pip
This is great, thanks @jsheunis ! 🌻 Just wanted to ping since it looks like there's only one small suggested revision, and I want to make sure this doesn't go stale. Let us know if we can help in any way ! |
@all-contributors please add @jsheunis for documentation ! |
I've put up a pull request to add @jsheunis! 🎉 |
replaces `python setup.py develop` with `pip install -e` Co-Authored-By: Joshua Teves <jbtevespro@gmail.com>
I'm a bit new to the process of reviews, suggestions, revisions, etc. I committed the change that @jbteves suggested, hope that was the right thing to do and the right way to do it! |
@jsheunis that's fine. When a reviewer makes a code suggestion GitHub offers the option to automatically create a commit and add it to the branch with the reviewer as co-author. If you make and push an otherwise identical commit manually on your own machine then the reviewer won't be co-authored unless you add a tag. That's the only real difference. I seriously doubt anybody will get bent out of shape about it. The nice thing with a suggested change is that it's just one click to add it if the original contributor agrees. |
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.
LGTM
Closes #346
Changes proposed in this pull request:
README:
CONTRIBUTING: