mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-05-28 19:26:55 +08:00

* chore(ci): checking links and spell checking * chore(ci): move markdown-link-check to GitHub ci Because pre-commit.ci does not have access to the internet... * fix(lib): revert `reverse-...` utils because of warnings * chore(ci): checking links and spell checking * chore(ci): move markdown-link-check to GitHub ci Because pre-commit.ci does not have access to the internet... * fix(docs): myst-parser xref cannot end with .html * fix(docs): oops
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
# Contributing
|
|
|
|
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!
|
|
|
|
```{toctree}
|
|
:hidden:
|
|
|
|
workflow
|
|
internals
|
|
```
|
|
|
|
[Workflow](/contributing/workflow)
|
|
: how to work on this project. Start here if you're a new contributor.
|
|
|
|
[Internals](/contributing/internals)
|
|
: how Manim Slides is built and how the various parts of it work.
|
|
|
|
## Reporting an Issue
|
|
|
|
```{include} ../../../README.md
|
|
:start-after: <!-- start reporting-an-issue -->
|
|
:end-before: <!-- end reporting-an-issue -->
|
|
```
|
|
|
|
## Seeking for Help
|
|
|
|
```{include} ../../../README.md
|
|
:start-after: <!-- start seeking-for-help -->
|
|
:end-before: <!-- end seeking-for-help -->
|
|
```
|
|
|
|
## Contact
|
|
|
|
```{include} ../../../README.md
|
|
:start-after: <!-- start contact -->
|
|
:end-before: <!-- end contact -->
|
|
```
|