Add CONTRIBUTING #165
Add CONTRIBUTING #165
Conversation
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipulgupta2048@gmail.com>
|
|
CONTRIBUTING.md
Outdated
| @@ -0,0 +1,33 @@ | |||
| # Contributing to Neural Network Intelligence (NNI) | |||
There was a problem hiding this comment.
Can you move this file to "docs" folder?
There was a problem hiding this comment.
Hi @vipulgupta2048 Sure thing, but isn't CONTRIBUTING supposed to be at the root level, for maximum visibility.
There was a problem hiding this comment.
hi @vipulgupta2048 , many thanks for your contribution :). this doc looks good, but I also suggest to move this file into docs/ folder, we could add a link at the bottom of the README.md at the root level. Another suggestion is that could you add a link to docs/HowToContribute.md at the proper place in this file.
There was a problem hiding this comment.
Changes made as requested.
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipulgupta2048@gmail.com>
|
Are there any style guidelines like PEP8, you guys follow. Or any naming conventions, some linters that travis has tests for. Any hard topics that you want to cover like making PR in separate branches, working with the team, how to you want to assign issues to contributors. Stuff like that. I write a lot of documentation. These are the usual things that goes into CONTRIBUTING. |
|
@vipulgupta2048 , for your suggestion about lint. Yes, we have tslint and pylint, and are working on enabling them in ci :). |
docs/CONTRIBUTING.md
Outdated
| A person looking to contribute can take up an issue by claiming it as a comment/assign their Github ID to it. In case there is no PR or update in progress for a week on the said issue, then the issue reopens for anyone to take up again. We need to consider high priority issues/regressions where response time must be a day or so. | ||
|
|
||
| ## Code Styles & Naming Conventions | ||
| < Need Help Here > |
There was a problem hiding this comment.
I need help here, don't merge it yet.
There was a problem hiding this comment.
Should I just add pep8?
There was a problem hiding this comment.
@vipulgupta2048 Yes, we discussed and agreed that we could use pep8 for python code convention
Hi, @vipulgupta2048 First, Thanks a lot for helping us draft the contributing document. Yes, we would like to cover the topics on how to send out PR (from your own forked repos to Microsoft/nni), merge PR(we prefer squash merge for cross-repository PR) ..etc |
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipulgupta2048@gmail.com>
|
@yds05 @xuehui1991 @QuanluZhang Ready to go. |
|
Thank you, everyone, this has been my first major open-source contribution to Microsoft. |
Signed-off-by: Vipul Gupta (@vipulgupta2048) vipulgupta2048@gmail.com