diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..fca1bc2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,53 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: '' +assignees: '' + +--- + +Thanks for helping us improve this project! + +**Before you create this issue** +Please make sure you are using the latest updated code and libraries: see https://github.com/ageron/handson-ml2/blob/master/INSTALL.md#update-this-project-and-its-libraries + +Also please make sure to read the FAQ (https://github.com/ageron/handson-ml2#faq) and search for existing issues (both open and closed), as your question may already have been answered: https://github.com/ageron/handson-ml2/issues + +**Describe the bug** +Please provide a clear and concise description of what the bug is, and specify the notebook name and the cell number at which the problem occurs (or the chapter and page in the book). + +**To Reproduce** +Please copy the code that fails here, using code blocks like this: + +```python +def inverse(x): + return 1 / x + +result = inverse(0) +``` + +And if you got an exception, please copy the full stacktrace here: + +```stacktrace +Traceback (most recent call last): + File "", line 1, in + File "", line 2, in inverse +ZeroDivisionError: division by zero +``` + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Versions (please complete the following information):** + - OS: [e.g. MacOSX 10.15.7] + - Python: [e.g. 3.7] + - TensorFlow: [e.g., 2.4.1] + - Scikit-Learn: [e.g., 0.24.1] +- Other libraries that may be connected with the issue: [e.g., gym 0.18.0] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/clarification-request.md b/.github/ISSUE_TEMPLATE/clarification-request.md new file mode 100644 index 0000000..fa7b52b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/clarification-request.md @@ -0,0 +1,53 @@ +--- +name: Clarification request +about: Not a bug, but something is not clear +title: "[QUESTION]" +labels: '' +assignees: '' + +--- + +Thanks for helping us improve this project! + +**Before you create this issue** +Please make sure you are using the latest updated code and libraries: see https://github.com/ageron/handson-ml2/blob/master/INSTALL.md#update-this-project-and-its-libraries + +Also please make sure to read the FAQ (https://github.com/ageron/handson-ml2#faq) and search for existing issues (both open and closed), as your question may already have been answered: https://github.com/ageron/handson-ml2/issues + +**Describe what is unclear to you** +Please provide a clear and concise description of what the problem is, and specify the notebook name and the cell number at which the problem occurs (or the chapter and page in the book). + +**To Reproduce** +If the question relates to a specific piece of code, please copy the code that fails here, using code blocks like this: + +```python +def inverse(x): + return 1 / x + +result = inverse(0) +``` + +And if you get an exception, please copy the full stacktrace here: + +```stacktrace +Traceback (most recent call last): + File "", line 1, in + File "", line 2, in inverse +ZeroDivisionError: division by zero +``` + +**Expected behavior** +If applicable, a clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Versions (please complete the following information):** + - OS: [e.g. MacOSX 10.15.7] + - Python: [e.g. 3.7] + - TensorFlow: [e.g., 2.4.1] + - Scikit-Learn: [e.g., 0.24.1] +- Other libraries that may be connected with the issue: [e.g., gym 0.18.0] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-or-improvement-request.md b/.github/ISSUE_TEMPLATE/feature-or-improvement-request.md new file mode 100644 index 0000000..579caff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-or-improvement-request.md @@ -0,0 +1,27 @@ +--- +name: Feature or Improvement request +about: Suggest an idea for this project +title: "[IDEA]" +labels: '' +assignees: '' + +--- + +Thanks for helping us improve this project! + +**Before you create this issue** +Please make sure you are using the latest updated code and libraries: see https://github.com/ageron/handson-ml2/blob/master/INSTALL.md#update-this-project-and-its-libraries + +Also please make sure to read the FAQ (https://github.com/ageron/handson-ml2#faq) and search for existing issues (both open and closed), as your question may already have been answered: https://github.com/ageron/handson-ml2/issues + +**Is your feature request related to a problem? Please describe.** +Please indicate the notebook name and cell number where the problem occurs (or the chapter and page number in the book), and provide a clear and concise description of what the problem is. Ex. In chapter 1, cells 200-220, I think the code could be clearer [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..4fa97d4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[IMPROVEMENT]" +labels: '' +assignees: '' + +--- + +Thanks for helping us improve this project! + +**Before you create this issue** +Please make sure you are using the latest updated code and libraries: see https://github.com/ageron/handson-ml2/blob/master/INSTALL.md#update-this-project-and-its-libraries + +Also please make sure to read the FAQ (https://github.com/ageron/handson-ml2#faq) and search for existing issues (both open and closed), as your question may already have been answered: https://github.com/ageron/handson-ml2/issues + +**Is your feature request related to a problem? Please describe.** +Please indicate the notebook name and cell number where the problem occurs (or the chapter and page number in the book), and provide a clear and concise description of what the problem is. Ex. In chapter 1, cells 200-220, I think the code could be clearer [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/request-for-clarification.md b/.github/ISSUE_TEMPLATE/request-for-clarification.md new file mode 100644 index 0000000..af8e83c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request-for-clarification.md @@ -0,0 +1,53 @@ +--- +name: Request for clarification +about: Not a bug, but something is not clear +title: "[QUESTION]" +labels: '' +assignees: '' + +--- + +Thanks for helping us improve this project! + +**Before you create this issue** +Please make sure you are using the latest updated code and libraries: see https://github.com/ageron/handson-ml2/blob/master/INSTALL.md#update-this-project-and-its-libraries + +Also please make sure to read the FAQ (https://github.com/ageron/handson-ml2#faq) and search for existing issues (both open and closed), as your question may already have been answered: https://github.com/ageron/handson-ml2/issues + +**Describe what is unclear to you** +Please provide a clear and concise description of what the problem is, and specify the notebook name and the cell number at which the problem occurs (or the chapter and page in the book). + +**To Reproduce** +If the question relates to a specific piece of code, please copy the code that fails here, using code blocks like this: + +```python +def inverse(x): + return 1 / x + +result = inverse(0) +``` + +And if you get an exception, please copy the full stacktrace here: + +```stacktrace +Traceback (most recent call last): + File "", line 1, in + File "", line 2, in inverse +ZeroDivisionError: division by zero +``` + +**Expected behavior** +If applicable, a clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Versions (please complete the following information):** + - OS: [e.g. MacOSX 10.15.7] + - Python: [e.g. 3.7] + - TensorFlow: [e.g., 2.4.1] + - Scikit-Learn: [e.g., 0.24.1] +- Other libraries that may be connected with the issue: [e.g., gym 0.18.0] + +**Additional context** +Add any other context about the problem here.