Browse Source

Merge pull request #8467 from ianhi/feature-requests

Add feature request template + slight reorg in readme
Steven Silvester 4 years ago
parent
commit
d8c0ba2272
2 changed files with 49 additions and 7 deletions
  1. 34 0
      .github/ISSUE_TEMPLATE/feature_request.md
  2. 15 7
      README.md

+ 34 - 0
.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,34 @@
+---
+name: Feature Request
+about: Suggest something to add to JupyterLab
+labels: type:Enhancement
+---
+
+<!--
+Welcome! Thanks for thinking of a way to improve JupyterLab. If this solves a problem for you, then it probably solves that problem for lots of people! So the whole community will benefit from this request.
+
+
+Before creating a new feature request please search the issues for relevant feature requests.
+-->
+
+### Problem
+
+<!-- Provide a clear and concise description of what problem this feature will solve. For example:
+
+* I'm always frustrated when [...] because [...]
+* I would like it if [...] happened when I [...] because [...]
+-->
+
+### Proposed Solution
+
+<!-- Provide a clear and concise description of a way to accomplish what you want. For example:
+
+* Add an option so that when [...]  [...] will happen
+ -->
+
+### Additional context
+
+<!-- Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. For example:
+
+* Another project [...] solved this by [...]
+-->

+ 15 - 7
README.md

@@ -103,11 +103,25 @@ See our [documentation](http://jupyterlab.readthedocs.io/en/latest/getting_start
 
 ---
 
+## Getting help
+
+We encourage you to ask questions on the [Discourse forum](https://discourse.jupyter.org/c/jupyterlab). A question answered there can become a useful resource for others.
+
+### Bug report
+
+To report a bug please read the [guidelines](https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html) and then open a [Github issue](https://github.com/jupyterlab/jupyterlab/issues/new?template=bug_report.md). To keep resolved issues self-contained, the [lock bot](https://github.com/apps/lock) will lock closed issues as resolved after a period of inactivity. If related discussion is still needed after an issue is locked, please open a new issue and reference the old issue.
+
+### Feature request
+
+We also welcome suggestions for new features as they help make the project more useful for everyone. To request a feature please use the [feature request template](https://github.com/jupyterlab/jupyterlab/issues/new?template=feature_request.md).
+
+---
+
 ## Development
 
 ### Contributing
 
-To contribute to the project, please read the [contributor documentation](CONTRIBUTING.md).
+To contribute code or documentation to the project, please read the [contributor documentation](https://jupyterlab.readthedocs.io/en/latest/developer/contributing.html).
 
 JupyterLab follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/community/content-community.html).
 
@@ -152,12 +166,6 @@ To be listed, please submit a pull request with your information.
 
 ---
 
-## Getting help
-
-We encourage you to ask questions on the [Discourse forum](https://discourse.jupyter.org/c/jupyterlab). A question answered there can become a useful resource for others.
-
-Please use the [GitHub issues page](https://github.com/jupyterlab/jupyterlab/issues) to provide feedback or submit a bug report. To keep resolved issues self-contained, the [lock bot](https://github.com/apps/lock) will lock closed issues as resolved after a period of inactivity. If related discussion is still needed after an issue is locked, please open a new issue and reference the old issue.
-
 ### Weekly Dev Meeting
 
 We have videoconference meetings every week where we discuss what we have been working on and get feedback from one another.