Skip to content

Restructuring of Contribution Section #1550

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

Merged
merged 10 commits into from
May 21, 2021

Conversation

Nikhil0504
Copy link
Contributor

@Nikhil0504 Nikhil0504 commented May 21, 2021

Changelog / Overview

Check the commits for the Changelog

Motivation

These changes make the contribution section of documentation more easier to read as it has been spilt up to the major topics.

Explanation for Changes

Developers can read this section more easier and won't have a problem navigating though the pages.

Documentation Reference

Testing Status

All Tests passes locally

Further Comments

Closes #1392 and closes #1466

Checklist

  • I have read the Contributing Guidelines
  • I have written a descriptive PR title (see top of PR template for examples)
  • I have written a changelog entry for the PR or deem it unnecessary
  • My new functions/classes either have a docstring or are private
  • My new functions/classes have tests added and (optional) examples in the docs
  • My new documentation builds, looks correctly formatted, and adds no additional build warnings

Reviewer Checklist

  • The PR title is descriptive enough
  • The PR is labeled correctly
  • The changelog entry is completed if necessary
  • Newly added functions/classes either have a docstring or are private
  • Newly added functions/classes have tests added and (optional) examples in the docs
  • Newly added documentation builds, looks correctly formatted, and adds no additional build warnings

@kolibril13
Copy link
Member

Thanks for this contribution, I really like the new sidebar!
image
Are there also changes in content, or is it only the structure that changed?
In case that is only the structure, I will approve it as it is :)

@Nikhil0504
Copy link
Contributor Author

Just restructuring for now.

@@ -0,0 +1,103 @@
==============
Adding Typings
==============
Copy link
Member

Choose a reason for hiding this comment

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

Add information about PEP-563, since we dropped py3.6 that should be something we can recommend.
See py3.7 changelog

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No this a PR for restructuring only I’ll do additions in a later PR which I’ll pull soon.

Copy link
Member

@naveen521kk naveen521kk left a comment

Choose a reason for hiding this comment

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

Ok, SGTM

@kolibril13 kolibril13 merged commit 6a3be27 into ManimCommunity:master May 21, 2021
@kolibril13 kolibril13 added the documentation Improvements or additions to documentation label May 21, 2021
@Nikhil0504 Nikhil0504 deleted the restructuring branch May 31, 2021 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update of contributing/documentation Restructuring the contribution page
3 participants