From d6ad56120e6e909c59f2d7e910f90d3cbcc7617f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Sun, 7 May 2023 23:01:44 +0200 Subject: [PATCH] chore(docs): update contributing guidelines (#177) Add seeking for help and reporting an issue sections. Closes #172 --- README.md | 52 ++++++++++++++++++++++++++++ docs/source/contributing/index.md | 31 +++++++++++++++-- docs/source/contributing/workflow.md | 2 +- 3 files changed, 81 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 22784e6..c4f5db0 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,9 @@ Tool for live presentations using either [Manim (community edition)](https://www - [F.A.Q](#faq) * [How to increase quality on Windows](#how-to-increase-quality-on-windows) - [Contributing](#contributing) + * [Reporting an Issue](#reporting-an-issue) + * [Seeking for Help](#seeking-for-help) + * [Contact](#contact) ## Installation @@ -200,6 +203,55 @@ in *Settings*->*Display*. Contributions are more than welcome! Please read through [our contributing section](https://eertmans.be/manim-slides/contributing/index.html). +### Reporting an Issue + + + +If you think you found a bug, +an error in the documentation, +or wish there was some feature that is currently missing, +we would love to hear from you! + +The best way to reach us is via the +[GitHub issues](https://github.com/jeertmans/manim-slides/issues). +If your problem is not covered by an already existing (closed or open) issue, +then we suggest you create a +[new issue](https://github.com/jeertmans/manim-slides/issues/new/choose). +You can choose from a list of templates, or open a +[blank issue](https://github.com/jeertmans/manim-slides/issues/new) +if your issue does not fit one of the proposed topics. + +The more precise you are in the description of your problem, the faster we will +be able to help you! + + + +### Seeking for help + + + +Sometimes, you may have a question about Manim Slides, +not necessarily an issue. + +There are two ways you can reach us for questions: + +- via the `Question/Help/Support` topic when +[choosing an issue template](https://github.com/jeertmans/manim-slides/issues/new/choose); +- or via +[GitHub discussions](https://github.com/jeertmans/manim-slides/discussions). + + + +### Contact + + + +Finally, if you do not have any GitHub account, +or just wish to contact the author of Manim Slides, +you can do so at: [jeertmans@icloud.com](mailto:jeertmans@icloud.com). + + + [pypi-version-badge]: https://img.shields.io/pypi/v/manim-slides?label=manim-slides [pypi-version-url]: https://pypi.org/project/manim-slides/ [pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/manim-slides diff --git a/docs/source/contributing/index.md b/docs/source/contributing/index.md index 7cf0fe7..fc99e12 100644 --- a/docs/source/contributing/index.md +++ b/docs/source/contributing/index.md @@ -2,10 +2,14 @@ Thank you for your interest in Manim Slides! ✨ -Manim Slides is an open source project, first created as a fork of [manim-presentation](https://github.com/galatolofederico/manim-presentation) (now deprecated in favor to Manim Slides), and we welcome contributions of all forms. - -This section is here to help fist-time contributors know how they can help this project grow. Whether you are already familiar with Manim or GitHub, it is worth taking a few minutes to read those documents! +Manim Slides is an open source project, first created as a fork of +[manim-presentation](https://github.com/galatolofederico/manim-presentation) +(now deprecated in favor to Manim Slides), +and we welcome contributions of all forms. +This section is here to help fist-time contributors know how they can help this +project grow. Whether you are already familiar with Manim or GitHub, +it is worth taking a few minutes to read those documents! ```{toctree} :hidden: @@ -19,3 +23,24 @@ internals [Internals](./internals) : how Manim Slides is built and how the various parts of it work. + +## Reporting an Issue + +```{include} ../../../README.md +:start-after: +:end-before: +``` + +## Seeking for Help + +```{include} ../../../README.md +:start-after: +:end-before: +``` + +## Contact + +```{include} ../../../README.md +:start-after: +:end-before: +``` diff --git a/docs/source/contributing/workflow.md b/docs/source/contributing/workflow.md index c5d5a82..f397fbe 100644 --- a/docs/source/contributing/workflow.md +++ b/docs/source/contributing/workflow.md @@ -11,7 +11,7 @@ This document is there to help you recreate a working environment for Manim Slid ## Forking the repository and cloning it locally -We used GitHub to host Manim Slides' repository, and we encourage contributors to use git. +We use GitHub to host Manim Slides' repository, and we encourage contributors to use git. Useful links: