Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,44 @@ our workflow that are not covered by a bot or status check are:
- Upon your first non-trivial pull request (which includes documentation changes),
feel free to add yourself to ``Misc/ACKS``

Cloning the Repository
----------------------
To clone the CPython repository, you can use the following command:

```sh
gh repo clone python/cpython
```

Setting Up the Development Environment
--------------------------------------
To set up your development environment, follow these steps:

1. Clone the repository using the command mentioned above.
2. Create a virtual environment:
```sh
python -m venv venv
```
3. Activate the virtual environment:
- On Windows:
```sh
venv\Scripts\activate
```
- On macOS and Linux:
```sh
source venv/bin/activate
```
4. Install the required dependencies:
```sh
pip install -r requirements.txt
```
5. Build the CPython source code:
```sh
./configure
make
make test
```

You are now ready to start contributing to CPython!

Setting Expectations
--------------------
Expand Down
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ body:
- Emailing [python-list](https://mail.python.org/mailman/listinfo/python-list)

Make sure to also search the [CPython issue tracker](https://github.com/python/cpython/issues?q=is%3Aissue+sort%3Acreated-desc) to check that the bug has not already been reported.

**Note:** If you are working on a cloned repository, make sure to pull the latest changes from the main branch using `gh repo clone python/cpython`.
- type: textarea
attributes:
label: "Bug description:"
Expand Down Expand Up @@ -54,3 +56,9 @@ body:
- Other
validations:
required: false
- type: input
attributes:
label: "Branch:"
description: "Specify the branch you are working on (e.g., main, feature-branch)."
validations:
required: true
39 changes: 39 additions & 0 deletions Doc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,42 @@ Bugs in the toolset should be reported to the tools themselves.

To help with the documentation, or report any problems, please leave a message
on `discuss.python.org <https://discuss.python.org/c/documentation>`_.

Cloning the Repository
======================

To clone the CPython repository, you can use the following command:

```sh
gh repo clone python/cpython
```

Contributing to the Documentation
=================================

If you are interested in contributing to the documentation, please follow these steps:

1. Clone the repository using the command mentioned above.
2. Create a virtual environment:
```sh
python -m venv venv
```
3. Activate the virtual environment:
- On Windows:
```sh
venv\Scripts\activate
```
- On macOS and Linux:
```sh
source venv/bin/activate
```
4. Install the required dependencies:
```sh
pip install -r requirements.txt
```
5. Make your changes to the documentation files.
6. Build the documentation to ensure your changes are correct:
```sh
make html
```
7. Submit a pull request with your changes.
44 changes: 43 additions & 1 deletion Doc/reference/executionmodel.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

.. _execmodel:

***************
Expand Down Expand Up @@ -402,3 +401,46 @@

.. [#] This limitation occurs because the code that is executed by these operations
is not available at the time the module is compiled.

.. _cloning-repo:

Cloning the Repository
======================

To clone the CPython repository, you can use the following command:

```sh
gh repo clone python/cpython
```

.. _setup-dev-env:

Setting Up the Development Environment
======================================

To set up your development environment for working on the execution model, follow these steps:

1. Clone the repository using the command mentioned above.
2. Create a virtual environment:
```sh
python -m venv venv
```
3. Activate the virtual environment:
- On Windows:
```sh
venv\Scripts\activate
```
- On macOS and Linux:

Check warning on line 433 in Doc/reference/executionmodel.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

Block quote ends without a blank line; unexpected unindent. [docutils]
```sh
source venv/bin/activate
```
4. Install the required dependencies:
```sh
pip install -r requirements.txt
```
5. Make your changes to the execution model documentation.
6. Build the documentation to ensure your changes are correct:
```sh
make html
```
7. Submit a pull request with your changes.
39 changes: 39 additions & 0 deletions Doc/using/windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1355,3 +1355,42 @@ Check :pep:`11` for details on all unsupported platforms.

See `Python for Windows <https://www.python.org/downloads/windows/>`_
for detailed information about platforms with pre-compiled installers.

.. _cloning-repo:

Cloning the Repository
======================

To clone the CPython repository, you can use the following command:

```sh
gh repo clone python/cpython
```

.. _setup-dev-env-windows:

Setting Up the Development Environment on Windows
=================================================

To set up your development environment on Windows, follow these steps:

1. Clone the repository using the command mentioned above.
2. Create a virtual environment:
```sh
python -m venv venv
```
3. Activate the virtual environment:
- On Windows:
```sh
venv\Scripts\activate
```
4. Install the required dependencies:
```sh
pip install -r requirements.txt
```
5. Make your changes to the code.
6. Build the code to ensure your changes are correct:
```sh
make build
```
7. Submit a pull request with your changes.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# CPython

CPython is the reference implementation of the Python programming language. It is written in C and provides the standard library for Python. This repository contains the source code for CPython, including the interpreter, standard library, and documentation.

## Cloning the Repository

To clone the CPython repository, you can use the following command:

```sh
gh repo clone python/cpython
```

## Documentation

For detailed information on how to build and contribute to the documentation, please refer to the [Doc/README.rst](Doc/README.rst) file.

## Contributing

If you are interested in contributing to CPython, please read the [CONTRIBUTING.rst](.github/CONTRIBUTING.rst) file for guidelines on how to get started.

## Bug Reports

To report bugs or issues, please use the [GitHub Issues](https://github.com/python/cpython/issues) page.

## Resources

- [Python Developer's Guide](https://devguide.python.org/)
- [Python Documentation](https://docs.python.org/3/)
- [Python Mailing Lists](https://mail.python.org/mailman/listinfo)
Loading