A community-maintained Python framework for creating mathematical animations.
Removed suggestion issue template, added FAQ answer regarding proposing new features (#2828)
Benjamin Hackl8bebfb907bcb
diff --git a/.github/ISSUE_TEMPLATE/suggestion.md b/.github/ISSUE_TEMPLATE/suggestion.mddeleted file mode 100644index 0d758dd5d..000000000--- a/.github/ISSUE_TEMPLATE/suggestion.md+++ /dev/null@@ -1,17 +0,0 @@-----name: Suggestion-about: Make a suggestion for the enhancement of existing features-title: ""-labels: enhancement-assignees: ''-------## Enhancement proposal-<!-- Add a clear and concise description of your enhancement proposal. In particular,- if your enhancement introduces changes to the API, illustrate them with- (fictional) code examples. -->---## Additional comments-<!-- Add further context that you think might be relevant. -->diff --git a/docs/source/contributing.rst b/docs/source/contributing.rstindex 79408d984..a9f7037d2 100644--- a/docs/source/contributing.rst+++ b/docs/source/contributing.rst@@ -6,7 +6,7 @@ Contributingcontributions implementing new features will not be accepted in this period.Other contributions unrelated to cleaning up the codebase may also take a longerperiod of time to be reviewed. This guide may quickly become outdated quickly; we- highly recommend joining our `Discord server <https://www.manim.community/discord/>`_+ highly recommend joining our `Discord server <https://www.manim.community/discord/>`__to discuss any potential contributions and keep up to date with the latest developments.Thank you for your interest in contributing to Manim! However you have decided to contribute@@ -27,6 +27,9 @@ some are detailed below:* Website design and development* Translating documentation and docstrings+To get an overview of what our community is currently working on, check out+`our development project board <https://github.com/orgs/ManimCommunity/projects/7/views/1>`__.+.. note::Please ensure that you are reading the latest version of this guide by ensuring that "latest" is selected in the version switcher.diff --git a/docs/source/faq/help.md b/docs/source/faq/help.mdindex a560b0310..c0c7a5e6d 100644--- a/docs/source/faq/help.md+++ b/docs/source/faq/help.md@@ -88,10 +88,12 @@ our `#manim-dev` channels in [our Discord](https://manim.community/discord/).2. Choose the correct category for your report when[creating a new issue](https://github.com/ManimCommunity/manim/issues/new/choose).- We have dedicated issue templates for *bug reports*, *feature requests*,- *installation issues*, and *suggestions*. If your report falls into one of these+ We have dedicated issue templates for *bug reports*, *feature requests*, and+ *installation issues*. If your report falls into one of thesecategories, read the issue template carefully! Instructions are given in the- `<!-- ... -->` sections of the text field.+ `<!-- ... -->` sections of the text field. If you want to suggest a new feature+ without concrete implementation details, see+ {ref}`the instructions given in this answer <creating-suggestions>`.3. For bug reports: prepare a minimal example that can be used to illustrate theissue. Examples with hundreds of lines are very inefficient and tedious to debug.@@ -103,3 +105,17 @@ our `#manim-dev` channels in [our Discord](https://manim.community/discord/).terminal output, from the command you used to run the library up to and includingthe last line with the error message. Read carefully: if the message mentionsthat there is another relevant log file, include this other file as well!++---++(creating-suggestions)=+## I have an idea for a really cool feature that should be implemented, where should I share my idea?++New suggestions and proposals should be made by+[creating a new discussion](https://github.com/ManimCommunity/manim/discussions/new?category=suggestions-and-proposals)+in the [*Suggestions and Proposals* category](https://github.com/ManimCommunity/manim/discussions/categories/suggestions-and-proposals)+in our GitHub repository. Once the raw idea has been formed into a more concrete,+implementable proposal that is supported by the community, and someone has expressed+interest in working on the new feature, a corresponding+[issue](https://github.com/ManimCommunity/manim/issues) will be created. Do **not** create+issues for suggesting new features directly, they will be closed down.