Skip to content

Commit db2bd49

Browse files
committed
Convert CONTRIBUTING.rst -> CONTRIBUTING.md
1 parent 47a699c commit db2bd49

File tree

2 files changed

+26
-28
lines changed

2 files changed

+26
-28
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# How to release
2+
3+
- Update `CHANGELOG.md`
4+
- Bump version (YYYY.MM) in `python_docs_theme/__init__.py`
5+
- Commit
6+
- Push to check tests pass on
7+
[GitHub Actions](https://github.com/python/python-docs-theme/actions)
8+
- Go to https://github.com/python/python-docs-theme/releases
9+
- Click "Draft a new release"
10+
- Click "Choose a tag"
11+
- Type the next YYYY.MM version (no leading zero) and
12+
select "**Create new tag: YYYY.MM** on publish"
13+
- Leave the "Release title" blank (it will be autofilled)
14+
- Click "Generate release notes" and amend as required
15+
- Click "Publish release"
16+
- Check the tagged [GitHub Actions build](https://github.com/python/python-docs-theme/actions/workflows/pypi-package.yml)
17+
has deployed to [PyPI](https://pypi.org/project/python-docs-theme/#history)
18+
19+
# Makefile usage
20+
21+
This project includes a simple Makefile for syncing changes to the theme with
22+
the main CPython repository. Run `make help` for details on available rules.
23+
24+
There is one configurable variable, `CPYTHON_PATH`, which should be the path
25+
to the CPython repository on your machine. By default, it points to
26+
`../cpython`.

CONTRIBUTING.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)