Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added license information to documentation landing page #3986

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Nikil-D-Gr8
Copy link

Overview: What does this pull request change?

  • Added a License Information section to the main documentation landing page to clarify the licensing terms, covering the MIT license, copyrighted assets, and sharing guidelines.

Motivation and Explanation: Why and how do your changes improve the library?

I am new to coding and open source, but I’m passionate about learning and contributing to projects I admire. Manim has been especially inspiring for me; I’ve learned a lot from Grant Sanderson’s videos, and I’m excited to contribute to this library. I wanted to add the license information to help users understand how they can use Manim, as outlined in issue #3833. This is my first pull request for Manim, and I tried to be careful, but any feedback or guidance on improving this PR is much appreciated!

Links to Issue

The License Information was added directly to the main documentation landing page (index.rst file). The link to view the issue for this PR is (#3833), where 3833 represents the issue number.

Further Information and Comments

I’m very new to programming (less than a year in), and I’m not yet very confident in my skills, but I’m enthusiastic about contributing however I can. I’m grateful for any help or advice the maintainers and reviewers can give me, especially if I’ve made any errors in this PR.

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

Copy link
Member

@JasonGrace2282 JasonGrace2282 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello and thanks for your interest in contributing to ✨ Manim ✨
At first glance this seems fine - I'll leave it up to @behackl to check if the wording is okay.

I think it might also be nice to include it on our README as well. If I remember correctly, there's also a special (albeit optional) way to cite Manim - what are your thoughts on including that?

If you have any questions feel free to let us know :)

Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution! The wording of the paragraph seems fine, there are just a bunch of minor issues I'd like you to look into:

Take a look and please let me know in case you have any particular concerns with these changes. Thanks again for your efforts!

@Nikil-D-Gr8
Copy link
Author

Thanks, I'll let you know if I need any help, thanks for the documentation, I was lost tbh and had to use chatgpt to understand what I was getting into, your help is much appreciated guys !

@JasonGrace2282
Copy link
Member

JasonGrace2282 commented Nov 3, 2024

You might also find this link helpful:
https://docs.manim.community/en/latest/contributing/docs.html

:)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

3 participants