Skip to content

Commit d6ad561

Browse files
authored
chore(docs): update contributing guidelines (#177)
Add seeking for help and reporting an issue sections. Closes #172
1 parent 5db0261 commit d6ad561

File tree

3 files changed

+81
-4
lines changed

3 files changed

+81
-4
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ Tool for live presentations using either [Manim (community edition)](https://www
2727
- [F.A.Q](#faq)
2828
* [How to increase quality on Windows](#how-to-increase-quality-on-windows)
2929
- [Contributing](#contributing)
30+
* [Reporting an Issue](#reporting-an-issue)
31+
* [Seeking for Help](#seeking-for-help)
32+
* [Contact](#contact)
3033

3134
## Installation
3235

@@ -200,6 +203,55 @@ in *Settings*->*Display*.
200203

201204
Contributions are more than welcome! Please read through [our contributing section](https://eertmans.be/manim-slides/contributing/index.html).
202205

206+
### Reporting an Issue
207+
208+
<!-- start reporting-an-issue -->
209+
210+
If you think you found a bug,
211+
an error in the documentation,
212+
or wish there was some feature that is currently missing,
213+
we would love to hear from you!
214+
215+
The best way to reach us is via the
216+
[GitHub issues](https://github.com/jeertmans/manim-slides/issues).
217+
If your problem is not covered by an already existing (closed or open) issue,
218+
then we suggest you create a
219+
[new issue](https://github.com/jeertmans/manim-slides/issues/new/choose).
220+
You can choose from a list of templates, or open a
221+
[blank issue](https://github.com/jeertmans/manim-slides/issues/new)
222+
if your issue does not fit one of the proposed topics.
223+
224+
The more precise you are in the description of your problem, the faster we will
225+
be able to help you!
226+
227+
<!-- end reporting-an-issue -->
228+
229+
### Seeking for help
230+
231+
<!-- start seeking-for-help -->
232+
233+
Sometimes, you may have a question about Manim Slides,
234+
not necessarily an issue.
235+
236+
There are two ways you can reach us for questions:
237+
238+
- via the `Question/Help/Support` topic when
239+
[choosing an issue template](https://github.com/jeertmans/manim-slides/issues/new/choose);
240+
- or via
241+
[GitHub discussions](https://github.com/jeertmans/manim-slides/discussions).
242+
243+
<!-- end seeking-for-help -->
244+
245+
### Contact
246+
247+
<!-- start contact -->
248+
249+
Finally, if you do not have any GitHub account,
250+
or just wish to contact the author of Manim Slides,
251+
you can do so at: [[email protected]](mailto:[email protected]).
252+
253+
<!-- end contact -->
254+
203255
[pypi-version-badge]: https://img.shields.io/pypi/v/manim-slides?label=manim-slides
204256
[pypi-version-url]: https://pypi.org/project/manim-slides/
205257
[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/manim-slides

docs/source/contributing/index.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

33
Thank you for your interest in Manim Slides! ✨
44

5-
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.
6-
7-
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!
5+
Manim Slides is an open source project, first created as a fork of
6+
[manim-presentation](https://github.com/galatolofederico/manim-presentation)
7+
(now deprecated in favor to Manim Slides),
8+
and we welcome contributions of all forms.
89

10+
This section is here to help fist-time contributors know how they can help this
11+
project grow. Whether you are already familiar with Manim or GitHub,
12+
it is worth taking a few minutes to read those documents!
913

1014
```{toctree}
1115
:hidden:
@@ -19,3 +23,24 @@ internals
1923

2024
[Internals](./internals)
2125
: how Manim Slides is built and how the various parts of it work.
26+
27+
## Reporting an Issue
28+
29+
```{include} ../../../README.md
30+
:start-after: <!-- start reporting-an-issue -->
31+
:end-before: <!-- end reporting-an-issue -->
32+
```
33+
34+
## Seeking for Help
35+
36+
```{include} ../../../README.md
37+
:start-after: <!-- start seeking-for-help -->
38+
:end-before: <!-- end seeking-for-help -->
39+
```
40+
41+
## Contact
42+
43+
```{include} ../../../README.md
44+
:start-after: <!-- start contact -->
45+
:end-before: <!-- end contact -->
46+
```

docs/source/contributing/workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This document is there to help you recreate a working environment for Manim Slid
1111

1212
## Forking the repository and cloning it locally
1313

14-
We used GitHub to host Manim Slides' repository, and we encourage contributors to use git.
14+
We use GitHub to host Manim Slides' repository, and we encourage contributors to use git.
1515

1616
Useful links:
1717

0 commit comments

Comments
 (0)