Skip to content

Conversation

@CasP0
Copy link

@CasP0 CasP0 commented Jan 4, 2025

Add instructions for cloning the repository using GitHub CLI.

  • README.md: Add a section on how to clone the repository using gh repo clone python/cpython. Mention the prerequisites for using GitHub CLI.
  • Doc/README.rst: Add instructions on cloning the repository using gh repo clone python/cpython. Include a note on installing GitHub CLI if not already installed.
  • Doc/using/unix.rst: Add a section on cloning the repository using gh repo clone python/cpython. Mention the prerequisites for using GitHub CLI.

For more details, open the Copilot Workspace session.


📚 Documentation preview 📚: https://cpython-previews--128471.org.readthedocs.build/

Add instructions for cloning the repository using GitHub CLI.

* **README.md**: Add a section on how to clone the repository using `gh repo clone python/cpython`. Mention the prerequisites for using GitHub CLI.
* **Doc/README.rst**: Add instructions on cloning the repository using `gh repo clone python/cpython`. Include a note on installing GitHub CLI if not already installed.
* **Doc/using/unix.rst**: Add a section on cloning the repository using `gh repo clone python/cpython`. Mention the prerequisites for using GitHub CLI.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/python/cpython?shareId=XXXX-XXXX-XXXX-XXXX).
@ghost
Copy link

ghost commented Jan 4, 2025

The following commit authors need to sign the Contributor License Agreement:

Click the button to sign:
CLA not signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Jan 4, 2025
@zanieb
Copy link
Contributor

zanieb commented Jan 4, 2025

Hi. Can you describe the motivation for this change?

This seems like a better fit for the devguide, e.g., at https://devguide.python.org/getting-started/setup-building/#get-the-source-code

This also adds a new README.md instead of modifying the existing README.rst.

@rruuaanng
Copy link
Contributor

I believe that modifying the README.md usually concerns the project's appearance, and it requires input from the core team for suggestions. cc @erlend-aasland (He has provided me with significant assistance in documentation in the past. And he is from the core team.)
(By the way, we should sign CLA to protect your rights regarding this submission.)

@skirpichev skirpichev added the pending The issue will be closed if no feedback is provided label Jan 4, 2025
@skirpichev
Copy link
Contributor

Thank you for your contribution, but I think this should be closed. README points to the Developer Guide. If you wish to reorganize documentation - I think it's severe enough to open first an issue or (better) a discussion thread in https://discuss.python.org/

Else - please open pr against https://github.com/python/devguide.

@skirpichev skirpichev closed this Jan 4, 2025
@skirpichev skirpichev removed the pending The issue will be closed if no feedback is provided label Jan 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

4 participants