From 979418886950e144b2cc561bdc5eb41d382cf829 Mon Sep 17 00:00:00 2001 From: Shauheen Zahirazami Date: Sat, 5 May 2018 13:47:44 -0700 Subject: [PATCH 1/5] Update contribution guide and issue/PR templates --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ ISSUE_TEMPLATE.md | 15 +++++++++++++++ PULL_REQUEST_TEMPLATE.md | 15 +++++++++++++++ 3 files changed, 53 insertions(+) create mode 100644 ISSUE_TEMPLATE.md create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2637b25cc0..514f6b4b2d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,26 @@ +# First things first: Welcome! + +If you are here, it means you are interested in helping us out. A hearty welcome and thank you! We always welcome new contribution to any of the following areas: +* Bug reports regarding the software or the documentation. +* Documentation updates, tutorial and examples. +* New code to implement a feature or patch an issue. + +## Getting started: + +Please join the community on [gitter](https://gitter.im/dotnet). Also please make sure to take a look at the project [roadmap](ROADMAP.md). + +### Pull requests + +If you are new to GitHub [here](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) is a detailed help source on getting involved with development on GitHub. + +As a first time contributor, you will be invited to sign the Contributor License Agreement (CLA). Please follow the instructions of the dotnet foundation bot reviewer on your PR to sign the agreement. Please note that only original code with signed CLA could be merged into the main repo. + +Your pull request needs to reference a filed issue. Please fill in the template that is populated for the pull request. Only pull requests adressing small typos can have no issues associated with them. + +An ML.NET team member will be assigned to your pull request once the continuous integration checks have passed successfully. + +All commits in a pull request will be squashed to a single commit with the original creator as author. + # Contributing See [Contributing](Documentation/project-docs/contributing.md) for information about coding styles, source structure, making pull requests, and more. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..27386e6002 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ +If you are filing an issue on GitHub, please ensure that it is a bug or a feature request or a major issue with the documentation. Also please take the time to fill out this form: + +### System information + +- **OS Platform and Distribution**: +- **dot net version**: +- **Exact steps to reproduce**: + +### Describe the problem + +Please use as much details as possible to explain why this is a bug or a feature request. + +### Source code / logs + +Please provide the code or logs or traces that would be helpful to diagnose the issue you are reporting. \ No newline at end of file diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..db12a1c53c --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +Please ensure that the title for the pull request is meaningful and includes exactly what was done. Your pull request needs to reference a filed issue. Only pull requests adressing small typos can have no issues associated with them. Please use the following template: + +``` +Issue #ISSUE_NUMBER THE_TITLE_OF_THE_PULL_REQUEST + +This addressed the issue by + * INSERT_DESCRIPTION_OF_SOMETHING + * INSERT_DESCRIPTION_OF_SOMETHING_ELSE + * ... + +Issues: + If your PR is addressing multiple issues, then list them all here. + This closes #ISSUE_NUMBER + This fixes #ISSUE_NUMBER +``` \ No newline at end of file From 5b332afd6ab13a7cac452f3328409a24f401f7fc Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Sun, 6 May 2018 20:32:33 -0700 Subject: [PATCH 2/5] Update ISSUE_TEMPLATE.md --- ISSUE_TEMPLATE.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 27386e6002..4412a83fba 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,15 +1,14 @@ -If you are filing an issue on GitHub, please ensure that it is a bug or a feature request or a major issue with the documentation. Also please take the time to fill out this form: - ### System information -- **OS Platform and Distribution**: -- **dot net version**: -- **Exact steps to reproduce**: +- **OS version/distro**: +- **.NET Version (eg., dotnet --info)**: -### Describe the problem +### Issue -Please use as much details as possible to explain why this is a bug or a feature request. +- **What did you do?** +- **What happened?** +- **What did you expect?** ### Source code / logs -Please provide the code or logs or traces that would be helpful to diagnose the issue you are reporting. \ No newline at end of file +Please paste or attach the code or logs or traces that would be helpful to diagnose the issue you are reporting. From 8d913e513b7b0e80aac3ee6ffac9f741729d2223 Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Sun, 6 May 2018 20:41:20 -0700 Subject: [PATCH 3/5] Update PULL_REQUEST_TEMPLATE.md --- PULL_REQUEST_TEMPLATE.md | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index db12a1c53c..22834a9c73 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,10 @@ -Please ensure that the title for the pull request is meaningful and includes exactly what was done. Your pull request needs to reference a filed issue. Only pull requests adressing small typos can have no issues associated with them. Please use the following template: - -``` -Issue #ISSUE_NUMBER THE_TITLE_OF_THE_PULL_REQUEST - -This addressed the issue by - * INSERT_DESCRIPTION_OF_SOMETHING - * INSERT_DESCRIPTION_OF_SOMETHING_ELSE - * ... - -Issues: - If your PR is addressing multiple issues, then list them all here. - This closes #ISSUE_NUMBER - This fixes #ISSUE_NUMBER -``` \ No newline at end of file +We welcome your PR! You'll want to look at this checklist before hitting Create: + +[ ] There's a descriptive title that will make sense to other developers some time from now. + +[ ] There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format `Fixes #nnnn` in your description to cause GitHub to automatically close the issue(s) when your PR is merged. + +[ ] Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know. + +[ ] You have tests, if at all possible. + From d0071f7d82dc3594a0ffa831cc2c771781993227 Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Sun, 6 May 2018 20:43:27 -0700 Subject: [PATCH 4/5] Update PULL_REQUEST_TEMPLATE.md --- PULL_REQUEST_TEMPLATE.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 22834a9c73..fd748884db 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,9 @@ -We welcome your PR! You'll want to look at this checklist before hitting Create: +We are excited to review your PR. -[ ] There's a descriptive title that will make sense to other developers some time from now. +So we can do the best job, please check: -[ ] There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format `Fixes #nnnn` in your description to cause GitHub to automatically close the issue(s) when your PR is merged. - -[ ] Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know. - -[ ] You have tests, if at all possible. +- [ ] There's a descriptive title that will make sense to other developers some time from now. +- [ ] There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format `Fixes #nnnn` in your description to cause GitHub to automatically close the issue(s) when your PR is merged. +- [ ] Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know. +- [ ] You have included any necessary tests in the same PR. From cfcb6cbb08db5a2b1f84294763bd99828b88b2ea Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Sun, 6 May 2018 20:47:00 -0700 Subject: [PATCH 5/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 514f6b4b2d..e2ca8d47b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,10 @@ -# First things first: Welcome! +# Welcome! -If you are here, it means you are interested in helping us out. A hearty welcome and thank you! We always welcome new contribution to any of the following areas: -* Bug reports regarding the software or the documentation. -* Documentation updates, tutorial and examples. -* New code to implement a feature or patch an issue. +If you are here, it means you are interested in helping us out. A hearty welcome and thank you! There are many ways you can contribute to the ML.NET project: + +* Offer PR's to fix bugs or implement new features. +* Give us feedback and bug reports regarding the software or the documentation. +* Improve our examples, tutorials, and documentation. ## Getting started: @@ -13,7 +14,7 @@ Please join the community on [gitter](https://gitter.im/dotnet). Also please mak If you are new to GitHub [here](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) is a detailed help source on getting involved with development on GitHub. -As a first time contributor, you will be invited to sign the Contributor License Agreement (CLA). Please follow the instructions of the dotnet foundation bot reviewer on your PR to sign the agreement. Please note that only original code with signed CLA could be merged into the main repo. +As a first time contributor, you will be invited to sign the Contributor License Agreement (CLA). Please follow the instructions of the dotnet foundation bot reviewer on your PR to sign the agreement indicating that you have appropriate rights to your contribution. Your pull request needs to reference a filed issue. Please fill in the template that is populated for the pull request. Only pull requests adressing small typos can have no issues associated with them.