From c874db6a6d076263949be41c43758c3de66db8d5 Mon Sep 17 00:00:00 2001 From: "Vipul Gupta (@vipulgupta2048)" Date: Sun, 7 Oct 2018 12:45:43 +0530 Subject: [PATCH 1/3] Add CONTRIBUTING Signed-off-by: Vipul Gupta (@vipulgupta2048) --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..c54e12c3f3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to Neural Network Intelligence (NNI) + +Great!! We are always on the lookout for more contributors to our code base. + +Firstly, if you are unsure or afraid of anything, just ask or submit the issue or pull request anyways. You won't be yelled at for giving your best effort. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions and don't want a wall of rules to get in the way of that. + +However, for those individuals who want a bit more guidance on the best way to contribute to the project, read on. This document will cover all the points we're looking for in your contributions, raising your chances of quickly merging or addressing your contributions. + +There are a few simple guidelines that you need to follow before providing your hacks. + +## Raising Issues + +When raising issues, please specify the following: +- Setup details needs to be filled as specified in the issue template clearly for the reviewer to check. +- A scenario where the issue occurred (with details on how to reproduce it). +- Errors and log messages that are displayed by the software. +- Any other details that might be useful. + +## Submit Proposals for New Features + +- There is always something more that is required, to make it easier to suit your use-cases. Feel free to join the discussion on new features or raise a PR with your proposed change. + +## Contributing to Source Code and Bug Fixes + +Provide PRs with appropriate tags for bug fixes or enhancements to the source code. Do follow the correct naming conventions and code styles when you work on and do try to implement all code reviews along the way. + +## Solve Existing Issues +Head over to [issues](https://github.com/Microsoft/nni/issues) to find issues where help is needed from contributors. You can find issues tagged with 'good-first-issue' or 'help-wanted' to contribute in. + +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 > From 8c42d1162cd9fa032e5c7773142d445041dabcde Mon Sep 17 00:00:00 2001 From: "Vipul Gupta (@vipulgupta2048)" Date: Mon, 8 Oct 2018 19:09:26 +0530 Subject: [PATCH 2/3] Changes made as requested Signed-off-by: Vipul Gupta (@vipulgupta2048) --- README.md | 2 +- CONTRIBUTING.md => docs/CONTRIBUTING.md | 2 ++ docs/HowToContribute.md | 3 ++- 3 files changed, 5 insertions(+), 2 deletions(-) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (92%) diff --git a/README.md b/README.md index b77ff37418..ba609b9a78 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ To learn more about how this example was constructed and how to analyze the expe * [Tutorial of the command tool *nnictl*.](docs/NNICTLDOC.md) # Contributing -This project welcomes contributions and suggestions, we are constructing the contribution guidelines, stay tuned =). +This project welcomes contributions and suggestions, please refer to our [contributing](./docs/CONTRIBUTING.md) document for the same. We use [GitHub issues](https://github.com/Microsoft/nni/issues) for tracking requests and bugs. diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 92% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md index c54e12c3f3..37ab3e57f4 100644 --- a/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -6,6 +6,8 @@ Firstly, if you are unsure or afraid of anything, just ask or submit the issue o However, for those individuals who want a bit more guidance on the best way to contribute to the project, read on. This document will cover all the points we're looking for in your contributions, raising your chances of quickly merging or addressing your contributions. +If you are looking for How to go about contributing and debugging the NNI source code, you can refer our [How to Contribute](./docs/HowToContribute.md) file in the `docs` folder. + There are a few simple guidelines that you need to follow before providing your hacks. ## Raising Issues diff --git a/docs/HowToContribute.md b/docs/HowToContribute.md index 87a570e182..c759e810d8 100644 --- a/docs/HowToContribute.md +++ b/docs/HowToContribute.md @@ -50,4 +50,5 @@ And open web ui to check if everything is OK After you change some code, just use **step 4** to rebuild your code, then the change will take effect immediately --- -At last, wish you have a wonderful day. \ No newline at end of file +At last, wish you have a wonderful day. +For more contribution guidelines on making PR's or issues to NNI source code, you can refer to our [CONTRIBUTING](./docs/CONTRIBUTING.md) document. \ No newline at end of file From e14476838852357b8ec0cd5161e0445bafb54b25 Mon Sep 17 00:00:00 2001 From: "Vipul Gupta (@vipulgupta2048)" Date: Tue, 9 Oct 2018 09:33:58 +0530 Subject: [PATCH 3/3] Changes made as requested#2 Signed-off-by: Vipul Gupta (@vipulgupta2048) --- README.md | 3 +++ docs/CONTRIBUTING.md | 10 ++++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ba609b9a78..0b4d0b385c 100644 --- a/README.md +++ b/README.md @@ -64,3 +64,6 @@ This project welcomes contributions and suggestions, please refer to our [contri We use [GitHub issues](https://github.com/Microsoft/nni/issues) for tracking requests and bugs. +# License +The entire codebase is under [MIT license](https://github.com/Microsoft/nni/blob/master/LICENSE) + diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 37ab3e57f4..80254c7af0 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -6,7 +6,7 @@ Firstly, if you are unsure or afraid of anything, just ask or submit the issue o However, for those individuals who want a bit more guidance on the best way to contribute to the project, read on. This document will cover all the points we're looking for in your contributions, raising your chances of quickly merging or addressing your contributions. -If you are looking for How to go about contributing and debugging the NNI source code, you can refer our [How to Contribute](./docs/HowToContribute.md) file in the `docs` folder. +Looking for a quickstart, get acquainted with our [Get Started](./docs/GetStarted.md) guide. There are a few simple guidelines that you need to follow before providing your hacks. @@ -22,14 +22,20 @@ When raising issues, please specify the following: - There is always something more that is required, to make it easier to suit your use-cases. Feel free to join the discussion on new features or raise a PR with your proposed change. +- Fork the repository under your own github handle. After cloning the repository. Add, commit, push and sqaush (if necessary) the changes with detailed commit messages to your fork. From where you can proceed to making a pull request. + ## Contributing to Source Code and Bug Fixes Provide PRs with appropriate tags for bug fixes or enhancements to the source code. Do follow the correct naming conventions and code styles when you work on and do try to implement all code reviews along the way. +If you are looking for How to go about contributing and debugging the NNI source code, you can refer our [How to Contribute](./docs/HowToContribute.md) file in the `docs` folder. + +Similarly for [writing trials](./docs/WriteYourTrial.md) or [starting experiments](StartExperiment.md). For everything else, refer [here](https://github.com/Microsoft/nni/tree/master/docs). + ## Solve Existing Issues Head over to [issues](https://github.com/Microsoft/nni/issues) to find issues where help is needed from contributors. You can find issues tagged with 'good-first-issue' or 'help-wanted' to contribute in. 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 > +We follow [PEP8](https://www.python.org/dev/peps/pep-0008/) for Python code and naming conventions, do try to adhere to the same when making a pull request or making a change. One can also take the help of linters such as `flake8` or `pylint`