Add contributing information #368
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #368 +/- ##
==========================================
+ Coverage 89.37% 89.5% +0.12%
==========================================
Files 32 32
Lines 2683 2744 +61
==========================================
+ Hits 2398 2456 +58
- Misses 285 288 +3
Continue to review full report at Codecov.
|
|
@amueller do you have some time to review this one? I think you're most experienced with user engagement. |
CONTRIBUTING.md
Outdated
| 3. Create a ``feature`` branch to hold your development changes: | ||
|
|
||
| ```bash | ||
| $ git checkout -b my-feature |
There was a problem hiding this comment.
I prefer using the branch type as a suffix to keep the overview, i.e.: feature/idea or feature-idea.
|
sorry @mfeurer not looking at github notifications right now (have 20000+) |
|
Legally, because the content of these files are partially copied from the scikit-learn/scikit-learn repository (CONTRIBUTING.md, ISSUE_TEMPLATE.md, PULL_REQUEST_TEMPLATE.md) I guess. |
|
Yep, those files are somewhat copied from scikit-learn, so to follow the BSD-license, we need to mention that. How about following this proposal? |
|
Okay, I just added a note about the files in question and added the license of scikit-learn to our license file. Should be fine like this. |
|
I can't review anymore since I made the last change, right? |
PGijsbers
left a comment
PGijsbers
left a comment
There was a problem hiding this comment.
Not an expert on the legality of it, but I seems fine to me. I made a change that mentions how to run unit tests for Windows users briefly.
@amueller a lot of this is actually copied from scikit-learn. Is there a special template that I need to follow to make this legally correct?