-
Notifications
You must be signed in to change notification settings - Fork 805
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adding new issue templates format +
bentoml env (#2689)
* feat: adding new issue templates format update some of the comments from PULL_REQUEST_TEMPLATE to introduce and encourage community members to contribute more Signed-off-by: Aaron Pham <[email protected]> * fix: formats Signed-off-by: Aaron Pham <[email protected]> * style: update formatting Signed-off-by: Aaron Pham <[email protected]> * chore: update configs Signed-off-by: Aaron Pham <[email protected]> * chore: fix templates Signed-off-by: Aaron Pham <[email protected]> * fix: templates Signed-off-by: Aaron Pham <[email protected]> * chore: updates bug_report Signed-off-by: Aaron Pham <[email protected]> * chore: udpates Signed-off-by: Aaron Pham <[email protected]> * chore: updates comments for Signed-off-by: Aaron Pham <[email protected]> * chore: updates field with placeholer for pip freeze Signed-off-by: Aaron Pham <[email protected]> * chore: address --env changes Signed-off-by: Aaron Pham <[email protected]> * chore: updates yamllint Signed-off-by: Aaron Pham <[email protected]> * feat: better env commands Signed-off-by: Aaron Pham <[email protected]> * chore: updates naming Signed-off-by: Aaron Pham <[email protected]> * revert: changes Signed-off-by: Aaron Pham <[email protected]> * chore: updates issue templates Signed-off-by: Aaron Pham <[email protected]> * revert: changes from main Signed-off-by: Aaron Pham <[email protected]> * chore: raise exception earlier Signed-off-by: Aaron Pham <[email protected]> * chore: migrate to its own file Signed-off-by: Aaron Pham <[email protected]> * chore: Apply suggestions from code review Co-authored-by: Sauyon Lee <[email protected]> * Update bug_report.yml * Update bug_report.yml * Update bug_report.yml * Update bug_report.yml * Update bug_report.yml * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Sauyon Lee <[email protected]> Co-authored-by: Sean Sheng <[email protected]>
- Loading branch information
3 people
authored
Jul 13, 2022
1 parent
69d5199
commit d0d216c
Showing
13 changed files
with
298 additions
and
208 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| name: 🐛 Bug Report | ||
| description: Create a bug report to help us improve BentoML. | ||
| title: "bug: " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| id: issue-already-exists | ||
| attributes: | ||
| value: | | ||
| Please search to see if an issue already exists for the bug you encountered. | ||
| See [Searching Issues and Pull Requests](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests) for how to use the GitHub search bar and filters. | ||
| - type: textarea | ||
| id: describe-the-bug | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Describe the bug | ||
| description: Please provide a clear and concise description about the problem you ran into. | ||
| placeholder: This happened when I... | ||
| - type: textarea | ||
| id: to-reproduce | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: To reproduce | ||
| description: | | ||
| Please provide a code sample or a code snipet to reproduce said problem. If you have code snippets, error messages, stack trace please also provide them here. | ||
| **IMPORTANT**: make sure to use [code tag](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) to correctly format your code. Screenshot is helpful but don't use it for code snippets as it doesn't allow others to copy-and-paste your code. | ||
| To give us more information for diagnosing the issue, make sure to enable debug logging: | ||
| Enable via environment variable, e.g.: | ||
| ```bash | ||
| BENTOML_DEBUG=TRUE bentoml serve ... | ||
| ``` | ||
| Or set debug logging in your Python code: | ||
| ```python | ||
| import logging | ||
| bentoml_logger = logging.getLogger("bentoml") | ||
| bentoml_logger.setLevel(logging.DEBUG) | ||
| ``` | ||
| For BentoML CLI commands, simply add the `--verbose` flag, e.g.: | ||
| ```bash | ||
| bentoml serve service.py:svc --verbose | ||
| ``` | ||
| placeholder: | | ||
| Steps to reproduce the bug: | ||
| 1. Provide '...' | ||
| 2. Run '...' | ||
| 3. See error | ||
| - type: textarea | ||
| id: expected-behavior | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: Expected behavior | ||
| description: "A clear and concise description of what you would expect to happen." | ||
| - type: textarea | ||
| id: environment-info | ||
| attributes: | ||
| label: Environment | ||
| description: | | ||
| Please share your environment with us. You should run `bentoml env` and paste the result here. | ||
| placeholder: | | ||
| bentoml: ... | ||
| python: ... | ||
| platform: ... | ||
| validations: | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,18 @@ | ||
| blank_issues_enabled: true | ||
| version: 2.1 | ||
| contact_links: | ||
| - name: BentoML's Documentation | ||
| url: https://docs.bentoml.org/en/latest/ | ||
| about: For more information about BentoML's tutorials, guides, API references and architectures deep-dive. | ||
| - name: BentoML Discussions | ||
| url: https://github.com/bentoml/BentoML/discussions | ||
| about: Please ask general questions here. | ||
| - name: BentoML Slack Community | ||
| url: https://join.slack.bentoml.org | ||
| about: For connecting with others in the community | ||
| about: For connecting with others in the community. | ||
| - name: BentoML Enterprise Support | ||
| url: [email protected] | ||
| about: Contact the BentoML team and learn more | ||
| about: Contact the BentoML team for support. | ||
| - name: BentoML Blog | ||
| url: modelserving.com | ||
| about: Read the latest blogs/updates from community and the BentoML team. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| name: 🚀 Feature Request | ||
| description: Submit a proposal/request for new BentoML feature. | ||
| title: "feature: " | ||
| labels: ["new-feature", "enhancement"] | ||
| body: | ||
| - type: textarea | ||
| id: feature-request | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Feature request | ||
| description: | | ||
| A clear and concise description of the feature request. | ||
| placeholder: | | ||
| I would like it if... | ||
| - type: textarea | ||
| id: motivation | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: Motivation | ||
| description: | | ||
| Please outline the motivation for this feature request. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. | ||
| If this is related to another issue, please link here too. | ||
| If you have a current workaround, please also provide it here. | ||
| placeholder: | | ||
| This feature would solve ... | ||
| - type: textarea | ||
| id: other | ||
| attributes: | ||
| label: Other | ||
| description: | | ||
| Is there any way that you could help, e.g. by submitting a PR? Please make sure to read the [contributing guidelines](https://github.com/bentoml/BentoML/blob/main/CONTRIBUTING.md) as well as [development guidelines](https://github.com/bentoml/BentoML/blob/main/DEVELOPMENT.md). | ||
| placeholder: | | ||
| I would love to contribute ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,59 @@ | ||
| <!--- Thanks for sending a pull request! | ||
| ## What does this PR address? | ||
| <!-- | ||
| Thanks for sending a pull request! | ||
| Congrats for making it this far! Here's a 🍱 for you. There are still a few steps ahead. | ||
| Please make sure to read the contribution guidelines, then fill out the blanks below before requesting a code review. | ||
| Name your Pull Request with one of the following prefixes, e.g. "feat: add support for PyTorch", to indicate the type of changes proposed. This is based on the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#summary). | ||
| - feat: (new feature for the user, not a new feature for build script) | ||
| - fix: (bug fix for the user, not a fix to a build script) | ||
| - docs: (changes to the documentation) | ||
| - style: (formatting, missing semicolons, etc; no production code change) | ||
| - refactor: (refactoring production code, eg. renaming a variable) | ||
| - perf: (code changes that improve performance) | ||
| - test: (adding missing tests, refactoring tests; no production code change) | ||
| - chore: (updating grunt tasks etc; no production code change) | ||
| - build: (changes that affect the build system or external dependencies) | ||
| - ci: (changes to configuration files and scripts) | ||
| - revert: (reverts a previous commit) | ||
| - feat: (new feature for the user, not a new feature for build script) | ||
| - fix: (bug fix for the user, not a fix to a build script) | ||
| - docs: (changes to the documentation) | ||
| - style: (formatting, missing semicolons, etc; no production code change) | ||
| - refactor: (refactoring production code, eg. renaming a variable) | ||
| - perf: (code changes that improve performance) | ||
| - test: (adding missing tests, refactoring tests; no production code change) | ||
| - chore: (updating grunt tasks etc; no production code change) | ||
| - build: (changes that affect the build system or external dependencies) | ||
| - ci: (changes to configuration files and scripts) | ||
| - revert: (reverts a previous commit) | ||
| --> | ||
|
|
||
| ## Description | ||
| <!--- Describe your changes in detail --> | ||
| <!--- Attach screenshots here if appropriate. --> | ||
| Describe your changes in detail. Attach screenshots here if appropriate. | ||
| ## Motivation and Context | ||
| <!--- Why is this change required? What problem does it solve? --> | ||
| <!--- If it fixes an open issue, please link to the issue here. --> | ||
| <!--- If it is based on a conversation in slack channel, pls quote related messages here --> | ||
| Once you're done with this, someone from BentoML team or community member will help review your PR (see "Who can help review?" section for potential reviewers.). If no one has reviewed your PR after a week have passed, don't hesitate to post a new comment and ping @-the same person. Notifications sometimes get lost 🥲. | ||
| --> | ||
|
|
||
| ## How Has This Been Tested? | ||
| <!--- Please describe in detail how you tested your changes. --> | ||
| <!--- Include details of your testing environment, and the tests you ran to --> | ||
| <!--- see how your change affects other areas of the code, etc. --> | ||
| <!-- Remove if not applicable --> | ||
| Fixes #(issue) | ||
|
|
||
| ## Checklist: | ||
| ## Before submitting: | ||
| <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
| <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
| <!--- If you plan to update documentation or tests in follow-up, please note --> | ||
| - [ ] My code follows the bentoml code style, both `make format` and | ||
| `make lint` script have passed | ||
| ([instructions](https://github.com/bentoml/BentoML/blob/master/DEVELOPMENT.md#style-check-and-auto-formatting-your-code)). | ||
| - [ ] My change reduces project test coverage and requires unit tests to be added | ||
| - [ ] I have added unit tests covering my code change | ||
| - [ ] My change requires a change to the documentation | ||
| - [ ] I have updated the documentation accordingly | ||
| - [ ] Does the Pull Request follow [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#summary) naming? Here are [GitHub's | ||
| guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) on how to create a pull request. | ||
| - [ ] Does the code follow BentoML's code style, both `make format` and `make lint` script have passed ([instructions](https://github.com/bentoml/BentoML/blob/main/DEVELOPMENT.md#style-check-auto-formatting-type-checking))? | ||
| - [ ] Did you read through [contribution guidelines](https://github.com/bentoml/BentoML/blob/main/CONTRIBUTING.md#ways-to-contribute) and follow [development guidelines](https://github.com/bentoml/BentoML/blob/main/DEVELOPMENT.md#start-developing)? | ||
| - [ ] Did your changes require updates to the documentation? Have you updated | ||
| those accordingly? Here are [documentation guidelines](https://github.com/bentoml/BentoML/tree/main/docs) and [tips on writting docs](https://github.com/bentoml/BentoML/tree/main/docs#writing-documentation). | ||
| - [ ] Did you write tests to cover your changes? | ||
|
|
||
| ## Who can help review? | ||
|
|
||
| Feel free to tag members/contributors who can help review your PR. | ||
| <!-- | ||
| Feel free to ping any of the BentoML members for help on your issue, but don't ping more than three people 😊. | ||
| If you know how to use git blame, that is probably the easiest way. | ||
| Team members that you can ping: | ||
| - @parano | ||
| - @yubozhao | ||
| - @bojiang | ||
| - @ssheng | ||
| - @aarnphm | ||
| - @sauyon | ||
| - @larme | ||
| - @yetone | ||
| - @jjmachan | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.