Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitbf0b600

Browse files
authored
Merge pull request#26790 from story645/auto-backport-of-pr-26737-on-v3.8.0-doc
Backport changes to contribute from PR#26737
2 parents3411279 +8c50ae8 commitbf0b600

File tree

1 file changed

+37
-32
lines changed

1 file changed

+37
-32
lines changed

‎doc/devel/contribute.rst

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -170,18 +170,18 @@ also welcome to post feature requests or pull requests.
170170

171171
If you are reporting a bug, please do your best to include the following:
172172

173-
1. A short, top-level summary of the bug. In most cases, this should be 1-2
173+
#. A short, top-level summary of the bug. In most cases, this should be 1-2
174174
sentences.
175175

176-
2. A short, self-contained code snippet to reproduce the bug, ideally allowing
176+
#. A short, self-contained code snippet to reproduce the bug, ideally allowing
177177
a simple copy and paste to reproduce. Please do your best to reduce the code
178178
snippet to the minimum required.
179179

180-
3. The actual outcome of the code snippet.
180+
#. The actual outcome of the code snippet.
181181

182-
4. The expected outcome of the code snippet.
182+
#. The expected outcome of the code snippet.
183183

184-
5. The Matplotlib version, Python version and platform that you are using. You
184+
#. The Matplotlib version, Python version and platform that you are using. You
185185
can grab the version with the following commands::
186186

187187
>>> import matplotlib
@@ -229,52 +229,54 @@ contribute to Matplotlib.
229229

230230
A brief overview of the workflow is as follows.
231231

232-
1. `Create an account<https://github.com/join>`_ on GitHub if you do not
232+
#. `Create an account<https://github.com/join>`_ on GitHub if you do not
233233
already have one.
234234

235-
2. Fork the `project repository<https://github.com/matplotlib/matplotlib>`_:
236-
click on the'Fork' button near the top of the page. This creates a copy of
237-
the code under your account on the GitHub server.
235+
#. Fork the `project repository<https://github.com/matplotlib/matplotlib>`_ by
236+
clicking on the:octicon:`repo-forked` **Fork** button near the top of the page.
237+
This creates a copy ofthe code under your account on the GitHub server.
238238

239-
..tab-set::
239+
#. Set up a development environment:
240240

241-
..tab-item::Local development
241+
..tab-set::
242242

243-
3. Clone this copy to your local disk::
243+
..tab-item::Local development
244244

245-
git clone https://github.com/<YOUR GITHUB USERNAME>/matplotlib.git
245+
Clone this copy to your local disk::
246246

247-
..tab-item::Using GitHub Codespaces
247+
git clone https://github.com/<YOUR GITHUB USERNAME>/matplotlib.git
248248

249-
3. Check out the Matplotlib repository and activate your development
250-
environment:
249+
..tab-item::Using GitHub Codespaces
251250

252-
* Open codespaces on your fork by clicking on the green "Code" button
251+
Check out the Matplotlib repository and activate your development environment:
252+
253+
#. Open codespaces on your fork by clicking on the green "Code" button
253254
on the GitHub web interface and selecting the "Codespaces" tab.
254-
* Next, click on "Open codespaces on <your branch name>". You will be
255+
256+
#. Next, click on "Open codespaces on <your branch name>". You will be
255257
able to change branches later, so you can select the default
256258
``main`` branch.
257-
* After the codespace is created, you will be taken to a new browser
259+
260+
#. After the codespace is created, you will be taken to a new browser
258261
tab where you can use the terminal to activate a pre-defined conda
259262
environment called ``mpl-dev``::
260263

261-
conda activate mpl-dev
262-
264+
conda activate mpl-dev
263265

264266

265-
4. Install the local version of Matplotlib with::
267+
#. Install the local version of Matplotlib with::
266268

267269
python -m pip install -e .
268270

269271
See :ref:`installing_for_devs` for detailed instructions.
270272

271-
5. Create a branch to hold your changes::
273+
#. Create a branch to hold your changes::
272274

273275
git checkout -b my-feature origin/main
274276

275277
and start making changes. Never work in the ``main`` branch!
276278

277-
6. Work on this task using Git to do the version control. Codespaces persist for
279+
#. Work on this task using Git to do the version control. Codespaces persist for
278280
some time (check the `documentation for details
279281
<https://docs.github.com/codespaces/getting-started/the-codespace-lifecycle>`_)
280282
and can be managed on https://github.com/codespaces. When you're done editing
@@ -301,11 +303,11 @@ GitHub Codespaces workflows
301303
<https://github.com/devcontainers/features/tree/main/src/desktop-lite>`_.
302304
You can use it by connecting to this desktop via your web browser. To do this:
303305

304-
1. Press ``F1`` or ``Ctrl/Cmd+Shift+P`` and select
306+
#. Press ``F1`` or ``Ctrl/Cmd+Shift+P`` and select
305307
``Ports: Focus on Ports View`` in the VSCode session to bring it into
306308
focus. Open the ports view in your tool, select the ``noVNC`` port, and
307309
click the Globe icon.
308-
2. In the browser that appears, click the Connect button and enter the desktop
310+
#. In the browser that appears, click the Connect button and enter the desktop
309311
password (``vscode`` by default).
310312

311313
Check the `GitHub instructions
@@ -391,10 +393,11 @@ Rules
391393
Introducing
392394
~~~~~~~~~~~
393395

394-
1. Announce the deprecation in a new file
396+
#. Announce the deprecation in a new file
395397
:file:`doc/api/next_api_changes/deprecations/99999-ABC.rst` where ``99999``
396398
is the pull request number and ``ABC`` are the contributor's initials.
397-
2. If possible, issue a `~matplotlib.MatplotlibDeprecationWarning` when the
399+
400+
#. If possible, issue a `~matplotlib.MatplotlibDeprecationWarning` when the
398401
deprecated API is used. There are a number of helper tools for this:
399402

400403
- Use ``_api.warn_deprecated()`` for general deprecation warnings
@@ -411,7 +414,7 @@ Introducing
411414

412415
You can use standard rst cross references in *alternative*.
413416

414-
3. Make appropriate changes to the type hints in the associated ``.pyi`` file.
417+
#. Make appropriate changes to the type hints in the associated ``.pyi`` file.
415418
The general guideline is to match runtime reported behavior.
416419

417420
- Items marked with ``@_api.deprecated`` or ``@_api.deprecate_privatize_attribute``
@@ -431,15 +434,17 @@ Introducing
431434
Expiring
432435
~~~~~~~~
433436

434-
1. Announce the API changes in a new file
437+
#. Announce the API changes in a new file
435438
:file:`doc/api/next_api_changes/[kind]/99999-ABC.rst` where ``99999``
436439
is the pull request number and ``ABC`` are the contributor's initials, and
437440
``[kind]`` is one of the folders:file:`behavior`,:file:`development`,
438441
:file:`removals`. See:file:`doc/api/next_api_changes/README.rst` for more
439442
information. For the content, you can usually copy the deprecation notice
440443
and adapt it slightly.
441-
2. Change the code functionality and remove any related deprecation warnings.
442-
3. Make appropriate changes to the type hints in the associated ``.pyi`` file.
444+
445+
#. Change the code functionality and remove any related deprecation warnings.
446+
447+
#. Make appropriate changes to the type hints in the associated ``.pyi`` file.
443448

444449
- Items marked with ``@_api.deprecated`` or ``@_api.deprecate_privatize_attribute``
445450
are to be removed on expiry.

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp