Skip to content

Conversation

@CorvidCanine
Copy link
Contributor

@CorvidCanine CorvidCanine commented Aug 31, 2020

Moved bug reporting guidelines to its own page, updated the code contribution guide to include the many notes at the end as actual steps. Adding tests and documentation probably shouldn't be in a note at the end.

This could have been in its own PR but I'm including it here; Added two a solutions to issues that may arise when installing that I came across when trying to get manim to run in Raspbian.

Changes

  • Move bug reporting guidelines from contributing.md to reporting_bugs.rst
  • Add reporting_bugs.rst to the index toxtree
  • Add links to the repo issue page and discord server in reporting_bugs.rst
  • Rewrite of the guide in contributing.md
  • Add direction of developers from installation.rst to contributing.md.
  • Add potential solution to missing letter from TexMobjects due to unbuilt TeX fonts in troubleshooting.rst
  • Add potential solution to "LaTeX' in the OpeningManimExample displaying incorrectly due to missing python to cairo binds.

Motivation

The code contributing guidelines were unclear and did not include important steps as actual steps.
Finding the guide to report bugs should be very easy to access.

Testing Status

make doctest only reports errors for python objects not included in the toctree, which I'm not going to add in this PR.

Acknowledgement

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.

Some comments,

@Aathish04 Aathish04 added Changes requested and not yet done documentation Improvements or additions to documentation labels Aug 31, 2020
@huguesdevimeux
Copy link
Member

Converting this to draft

@huguesdevimeux huguesdevimeux marked this pull request as draft September 1, 2020 08:46
@leotrs
Copy link
Contributor

leotrs commented Sep 2, 2020

BTW, the contributing guidelines have moved to docs/source/contributing.md. Please merge from master and update this PR :)

@CorvidCanine
Copy link
Contributor Author

Thank you for looking through everything @naveen521kk. I've made the changes you suggested, except for the installation link from contributing.md. I'm not sure what's wrong with it?
The python-cario bindings fixed the issue for me on Raspbian, but I've removed it until I/someone can do more research into this.
@leotrs Thank's for pointing out the file move.

@leotrs leotrs marked this pull request as ready for review September 2, 2020 18:18
@leotrs
Copy link
Contributor

leotrs commented Sep 2, 2020

Hmm for some reason your PR is now listing 302 files changed 😅 It might be easier to branch again from a fresh master and rebase your commits, if that's at all possible on your end :)

@CorvidCanine
Copy link
Contributor Author

After a not-so-elegant attempt at a rebase, github should now be showing 5 file changes by 1 new commit.

@leotrs
Copy link
Contributor

leotrs commented Sep 3, 2020

LGTM! Please fix @naveen521kk 's suggestion.

@naveen521kk, if you think this is ready, let me know and I'll merge!

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.

Some small suggestion

CorvidCanine and others added 2 commits September 3, 2020 11:07
Instead of saying how to checkout any branch, change contributing.md to say how to checkout the master branch specifically.
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.

Looks good for me. Just a reminder to myself that I need to edit these in #165

@naveen521kk naveen521kk added pr:easy review There is nothing particular (i.e, it's about a general/small thing) to know for review! and removed Changes requested and not yet done labels Sep 5, 2020
@leotrs leotrs merged commit 95ff9f8 into ManimCommunity:master Sep 5, 2020
@leotrs
Copy link
Contributor

leotrs commented Sep 5, 2020

Thank you @CorvidCanine ! We look forward to your future contributions :)

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 pr:easy review There is nothing particular (i.e, it's about a general/small thing) to know for review!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants