-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Rewrite contributing guide and add two troubleshooting soulutions #384
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
Conversation
naveen521kk
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments,
|
Converting this to draft |
|
BTW, the contributing guidelines have moved to docs/source/contributing.md. Please merge from master and update this PR :) |
|
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? |
|
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 :) |
…troubleshooting solution
|
After a not-so-elegant attempt at a rebase, github should now be showing 5 file changes by 1 new commit. |
|
LGTM! Please fix @naveen521kk 's suggestion. @naveen521kk, if you think this is ready, let me know and I'll merge! |
naveen521kk
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some small suggestion
Co-authored-by: Naveen M K <[email protected]>
Instead of saying how to checkout any branch, change contributing.md to say how to checkout the master branch specifically.
naveen521kk
left a comment
There was a problem hiding this 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
|
Thank you @CorvidCanine ! We look forward to your future contributions :) |
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
twoa solutionsto issues that may arise when installing that I came across when trying to get manim to run in Raspbian.Changes
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 doctestonly reports errors for python objects not included in the toctree, which I'm not going to add in this PR.Acknowledgement