Skip to content

Commit

Permalink
[MLRun] Add Copyright Disclaimer (#2286)
Browse files Browse the repository at this point in the history
  • Loading branch information
eliyahu77 committed Aug 23, 2022
1 parent 8240eaf commit 48e15a1
Show file tree
Hide file tree
Showing 547 changed files with 7,913 additions and 255 deletions.
150 changes: 82 additions & 68 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -1,68 +1,82 @@
name: Bug Report
description: Report incorrect behavior in the MLRun Kit
title: "[Bug]: "

body:
- type: checkboxes
id: checks
attributes:
label: MLRun Version checks
options:
- label: >
I have checked that this issue has not already been reported.
required: true
- label: >
I have confirmed this bug exists on the latest version of the MLRun Kit.
required: true
- type: textarea
id: example
attributes:
label: Reproducible Example
description: >
If you are running an existing example/demo, please link it here. Otherwise please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to
provide a minimal, copy-pastable example.
placeholder: >
import mlrun
...
render: python
validations:
required: true
- type: textarea
id: problem
attributes:
label: Issue Description
description: >
Please provide a description of the issue shown in the reproducible example.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: >
Please describe or show a code example of the expected behavior.
validations:
required: true
- type: input
id: python_version
attributes:
label: Python Version
description: >
Please paste the output of ``import platform; platform.python_version()``
validations:
required: true
- type: input
id: mlrun_version
attributes:
label: MLRun Version
description: >
Please paste the output of ``import mlrun; mlrun.get_version()``
validations:
required: true
- type: textarea
id: additional_information
attributes:
label: Additional Information
description: >
Please add any aditional information you think may be relevant.
# Copyright 2018 Iguazio
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
name: Bug Report
description: Report incorrect behavior in the MLRun Kit
title: "[Bug]: "

body:
- type: checkboxes
id: checks
attributes:
label: MLRun Version checks
options:
- label: >
I have checked that this issue has not already been reported.
required: true
- label: >
I have confirmed this bug exists on the latest version of the MLRun Kit.
required: true
- type: textarea
id: example
attributes:
label: Reproducible Example
description: >
If you are running an existing example/demo, please link it here. Otherwise please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to
provide a minimal, copy-pastable example.
placeholder: >
import mlrun
...
render: python
validations:
required: true
- type: textarea
id: problem
attributes:
label: Issue Description
description: >
Please provide a description of the issue shown in the reproducible example.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: >
Please describe or show a code example of the expected behavior.
validations:
required: true
- type: input
id: python_version
attributes:
label: Python Version
description: >
Please paste the output of ``import platform; platform.python_version()``
validations:
required: true
- type: input
id: mlrun_version
attributes:
label: MLRun Version
description: >
Please paste the output of ``import mlrun; mlrun.get_version()``
validations:
required: true
- type: textarea
id: additional_information
attributes:
label: Additional Information
description: >
Please add any aditional information you think may be relevant.
22 changes: 18 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
contact_links:
- name: Question/Help/Support
url: https://go.iguazio.com/mlopslive/joincommunity
about: "If you have a question, please join the MLOps Live community on Slack."
# Copyright 2018 Iguazio
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
contact_links:
- name: Question/Help/Support
url: https://go.iguazio.com/mlopslive/joincommunity
about: "If you have a question, please join the MLOps Live community on Slack."
94 changes: 54 additions & 40 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yaml
Original file line number Diff line number Diff line change
@@ -1,40 +1,54 @@
name: Documentation Improvement
description: Report wrong or missing documentation
title: "[Docs]: "

body:
- type: checkboxes
attributes:
label: MLRun Kit version checks
options:
- label: >
I have checked that the issue still exists on the latest versions of the docs
[here](https://docs.mlrun.org/en/latest/)
required: true
- type: textarea
id: location
attributes:
label: Location of the documentation
description: >
Please provide the location of the documentation, e.g. "mlrun.get_or_create_project" or the
URL of the documentation, e.g.
"https://docs.mlrun.org/en/latest/projects/create-load-import-project.html"
placeholder: https://docs.mlrun.org/en/latest/projects/create-load-import-project.html
validations:
required: true
- type: textarea
id: problem
attributes:
label: Documentation problem
description: >
Please provide a description of what documentation you believe needs to be fixed/improved
validations:
required: true
- type: textarea
id: suggested-fix
attributes:
label: Suggested fix for documentation
description: >
Please explain the suggested fix and **why** it's better than the existing documentation
validations:
required: true
# Copyright 2018 Iguazio
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
name: Documentation Improvement
description: Report wrong or missing documentation
title: "[Docs]: "

body:
- type: checkboxes
attributes:
label: MLRun Kit version checks
options:
- label: >
I have checked that the issue still exists on the latest versions of the docs
[here](https://docs.mlrun.org/en/latest/)
required: true
- type: textarea
id: location
attributes:
label: Location of the documentation
description: >
Please provide the location of the documentation, e.g. "mlrun.get_or_create_project" or the
URL of the documentation, e.g.
"https://docs.mlrun.org/en/latest/projects/create-load-import-project.html"
placeholder: https://docs.mlrun.org/en/latest/projects/create-load-import-project.html
validations:
required: true
- type: textarea
id: problem
attributes:
label: Documentation problem
description: >
Please provide a description of what documentation you believe needs to be fixed/improved
validations:
required: true
- type: textarea
id: suggested-fix
attributes:
label: Suggested fix for documentation
description: >
Please explain the suggested fix and **why** it's better than the existing documentation
validations:
required: true
116 changes: 65 additions & 51 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -1,51 +1,65 @@
name: Feature Request
description: Suggest an idea for MLRun
title: "[Feature Request]: "

body:
- type: checkboxes
id: checks
attributes:
label: Feature Type
description: Please check what type of feature request you would like to propose.
options:
- label: >
Adding new functionality to MLRun
- label: >
Changing existing functionality in MLRun
- label: >
Removing existing functionality in MLRun
- type: textarea
id: description
attributes:
label: Problem Description
description: >
Please describe what problem the feature would solve, e.g. "I wish I could use MLRun to ..."
placeholder: >
I wish I could use MLRun to serve a PyTorch model.
validations:
required: true
- type: textarea
id: feature
attributes:
label: Feature Description
description: >
Please describe how the new feature would be implemented, using psudocode if relevant.
validations:
required: true
- type: textarea
id: alternative
attributes:
label: Alternative Solutions
description: >
Please describe any alternative solution (existing functionality, 3rd party package, etc.)
that would satisfy the feature request.
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: >
Please provide any relevant Github issues, code examples or references that help describe and support
the feature request.
# Copyright 2018 Iguazio
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
name: Feature Request
description: Suggest an idea for MLRun
title: "[Feature Request]: "

body:
- type: checkboxes
id: checks
attributes:
label: Feature Type
description: Please check what type of feature request you would like to propose.
options:
- label: >
Adding new functionality to MLRun
- label: >
Changing existing functionality in MLRun
- label: >
Removing existing functionality in MLRun
- type: textarea
id: description
attributes:
label: Problem Description
description: >
Please describe what problem the feature would solve, e.g. "I wish I could use MLRun to ..."
placeholder: >
I wish I could use MLRun to serve a PyTorch model.
validations:
required: true
- type: textarea
id: feature
attributes:
label: Feature Description
description: >
Please describe how the new feature would be implemented, using psudocode if relevant.
validations:
required: true
- type: textarea
id: alternative
attributes:
label: Alternative Solutions
description: >
Please describe any alternative solution (existing functionality, 3rd party package, etc.)
that would satisfy the feature request.
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: >
Please provide any relevant Github issues, code examples or references that help describe and support
the feature request.
Loading

0 comments on commit 48e15a1

Please sign in to comment.