-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🔄 Synced file(s) with nebari-dev/.github (#1550)
* 🔄 Synced local '.github/ISSUE_TEMPLATE/' with remote '.github/ISSUE_TEMPLATE/' MAINT - Sync .github files 🤖 * 🔄 Synced local 'LICENSE' with remote 'LICENSE' MAINT - Sync .github files 🤖 * 🔄 Synced local 'CONTRIBUTING.md' with remote 'CONTRIBUTING.md' MAINT - Sync .github files 🤖 * 🔄 Synced local '.github/ISSUE_TEMPLATE/bug-report.yml' with remote '.github/ISSUE_TEMPLATE/bug-report-nebari.yml' MAINT - Sync .github files 🤖 * 🔄 Synced local '.github/PULL_REQUEST_TEMPLATE.md' with remote '.github/PULL_REQUEST_TEMPLATE_simple.md' MAINT - Sync .github files 🤖 Co-authored-by: nebari-sensei <null>
- Loading branch information
1 parent
247b8e5
commit 21db764
Showing
8 changed files
with
252 additions
and
222 deletions.
There are no files selected for viewing
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,52 @@ | ||
| --- | ||
| name: "Request for Discussion (RFD) 💬" | ||
| about: Open discussion about a feature or design project in Nebari. | ||
| labels: | ||
| - "type: RFD" | ||
| title: "RFD - Title" | ||
| --- | ||
|
|
||
| <!-- Example of when and how to create a RFD or RFC (request for comments) --> | ||
| <!-- https://gitpod.notion.site/Decision-Making-RFCs-eb4a57f3a34f40f1afbd95e05322af70 --> | ||
|
|
||
| <!-- Use this guide to set the status: Draft 🚧 / Open for comments 💬/ Accepted ✅ /Implemented 🚀/ Obsolete 🗃 --> | ||
|
|
||
| | Status | Draft 🚧 / Open for comments 💬/ Accepted ✅ /Implemented 🚀/ Obsolete 🗃 | | ||
| | ----------------- | ------------------------------------------------------------------------ | | ||
| | Author(s) | GitHub handle | | ||
| | Date Created | dd-MM-YYY | | ||
| | Date Last updated | dd-MM-YYY | | ||
| | Decision deadline | dd-MM-YYY | | ||
|
|
||
| # Title | ||
|
|
||
| ## Summary | ||
|
|
||
| <!-- What are we trying to solve here? Try and make this concise--> | ||
|
|
||
| ## User benefit | ||
|
|
||
| <!-- How will users (or other contributors) benefit from this work? What would be the headline in the release notes or blog post? --> | ||
|
|
||
| ## Design Proposal | ||
|
|
||
| <!--This is the meat of the document, where you explain your proposal. | ||
| Explain the design in enough detail for somebody familiar with the project to understand. Include examples of how the feature/implementation will work. Feel free to add schematics, drawings or other supporting visual material. --> | ||
|
|
||
| ### Alternatives or approaches considered (if any) | ||
|
|
||
| <!-- Make sure to discuss the relative merits of alternatives to your proposal. --> | ||
|
|
||
| ### Best practices | ||
|
|
||
| <!-- Does this proposal change best practices for some aspect of using/developing JupyterLab or other project? How will these changes be communicated/enforced? | ||
| --> | ||
|
|
||
| ### User impact | ||
|
|
||
| <!-- What are the user-facing changes? How will this feature be rolled out? --> | ||
|
|
||
| ## Unresolved questions | ||
|
|
||
| <!-- Seed this with open questions you require feedback on from the RFD process. --> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,11 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Nebari Documentation 📖 | ||
| url: https://docs.nebari.dev/en/stable/ | ||
| about: Read Nebari docs and development guide. | ||
| - name: GitHub discussions 💬 | ||
| url: https://github.com/Quansight/nebari/discussions | ||
| about: Keep up to date with the community discussions | ||
| - name: "(maintainers only) Blank issue" | ||
| url: https://github.com/Quansight/nebari/issues/new | ||
| - name: Nebari Documentation | ||
| url: https://www.nebari.dev/docs/ | ||
| about: Check out the Nebari documentation | ||
| - name: Nebari Discussions - our user forum | ||
| url: https://github.com/orgs/nebari-dev/discussions | ||
| about: Ask questions, discuss RFDs and help other Nebari's users | ||
| - name: (maintainers only) - Blank issue | ||
| url: https://github.com/nebari-dev/nebari/issues/new | ||
| about: For maintainers only - should be used sparingly |
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,56 @@ | ||
| name: "Documentation 📖" | ||
| description: Did you find an error in our documentation? Report your findings here. | ||
| title: "[DOC] - <title>" | ||
| labels: ["area: documentation 📖"] | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| # Welcome 👋 | ||
| Thanks for using Nebari and taking some time to contribute to this project. | ||
| Please fill out each section below. This info allows Nebari maintainers to diagnose (and fix!) your issue as | ||
| quickly as possible. | ||
| Before submitting a bug, please make sure the issue hasn't been already addressed by searching through | ||
| [the past issues](https://github.com/nebari-dev/nebari-docs/issues). | ||
| Useful links: | ||
| - Documentation: https://www.nebari.dev | ||
| - Contribution guidelines: https://www.nebari.dev/community/ | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Preliminary Checks | ||
| description: Please make sure that you verify each checkbox and follow the instructions for them. | ||
| options: | ||
| - label: "This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions" | ||
| required: true | ||
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Summary | ||
| description: | | ||
| What problem(s) did you run into that caused you to request a fix to the documentation or additional | ||
| documentation? What questions do you think we should answer? | ||
| - type: textarea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Steps to Resolve this Issue | ||
| description: | | ||
| How can the problem be solved? Are there any additional steps required? Do any other pages need to be updated? | ||
| value: | | ||
| 1. | ||
| 2. | ||
| 3. | ||
| ... | ||
| - type: markdown | ||
| attributes: | ||
| value: > | ||
| Thanks for contributing 🎉! |
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,52 @@ | ||
| name: "General issue 💡" | ||
| description: "A general template for many kinds of issues." | ||
| title: "<title>" | ||
| labels: ["needs: triage 🚦"] | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| # Welcome 👋 | ||
| Thanks for using Nebari and taking some time to contribute to this project. | ||
| Please fill out each section below. This info allows Nebari maintainers to diagnose (and fix!) your issue as | ||
| quickly as possible. | ||
| Before submitting a bug, please make sure the issue hasn't been already addressed by searching through | ||
| the past issues in this repository. | ||
| Useful links: | ||
| - Documentation: https://www.nebari.dev | ||
| - Contributing: https://www.nebari.dev/community/ | ||
| - type: textarea | ||
| attributes: | ||
| label: Context | ||
| description: | | ||
| Describe what you are proposing. Provide as much context as possible and link to related issues and/or pull requests. | ||
| This section should contain "what" you are proposing. | ||
| Are you having any problems? Briefly describe what your pain points are. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Value and/or benefit | ||
| description: | | ||
| What is the value of adding this feature, and who will benefit from it? Include any information that could help us prioritize the issue. | ||
| This section should contain "why" this issue should be resolved. | ||
| ✨ If this is for a new feature or enhancement, consider adding [user stories](https://www.atlassian.com/agile/project-management/user-stories). | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Anything else? | ||
| description: | | ||
| Links? References? Anything that will give us more context about the issue you are encountering! | ||
| Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
| validations: | ||
| required: false |
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.