-
-
Notifications
You must be signed in to change notification settings - Fork 782
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
Adding Codespaces Documentation #1144
Conversation
CC @brettcannon 😄 |
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.
Thanks for working on this, a few minor comments :)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Thank you @hugovk! Your suggestions make sense to me. Let me know if you think there's anything else I should change! |
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.
The actual text content looks pretty good. I've only very briefly tried codespaces, so it would be good for someone more familiar to check this too.
Oh, by the way, we usually limit lines to around 80 characters (see https://devguide.python.org/documentation/style-guide/#use-of-whitespace). Please could you add some line breaks?
Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>
Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
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.
A couple of suggestions, but they are all minor.
Co-authored-by: Brett Cannon <brett@python.org>
Co-authored-by: Brett Cannon <brett@python.org>
Co-authored-by: Brett Cannon <brett@python.org>
Co-authored-by: Brett Cannon <brett@python.org>
I think this is ready for merge, just one thing, please could you add some newlines so each line is no longer than around 80 characters? This will make it easier to read in the editor, and more importantly, new changes will be easier to review in future PRs. Thanks! |
Hi @hugovk! Yes! I was just working on that and added them in. Sorry for the delay with that. Appreciate the feedback on it! |
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.
All good, thank you very much!
Thanks, Marlene, for the PR and everyone for their comments! |
Thank you Brett, Hugo, Erlend and Pradyun for the help with this!!! My first PR to Python 😄 Very excited and happy to help! |
Congratulations and good work! This guide should be useful for the PyCon Korea sprint next week :) |
Hi, I'd like to add documentation to show how to use Codespaces for contributing to CPython with the devcontainer files Brett added. I've added the instructions at the bottom of the
Setup and Building
page. I initially added them as a separate page but thought this might be more appropriate. Feel free to let me know if you think they should live somewhere else.This is a PR that would solve #1138. I added some context about the discussions and places where some people had asked for docs in the issue. (Also sorry for the other closed PR's still getting used to contributing :))
📚 Documentation preview 📚: https://cpython-devguide--1144.org.readthedocs.build/