Skip to content

Commit

Permalink
Fix
Browse files Browse the repository at this point in the history
  • Loading branch information
francescobianco committed Feb 28, 2024
1 parent 28338cb commit e71c91e
Show file tree
Hide file tree
Showing 6 changed files with 186 additions and 7 deletions.
Empty file added .github/workflows/syntax.yml
Empty file.
165 changes: 165 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
# Contributing Guidelines

To learn more about the purpose of PEPs and how to go about writing one,
please start reading at [DX Tech Paper 1](https://devpasta.github.io/dx-0001/).
Also, make sure to check the [README](./README.md) for information on
how to render the DX Tech papers in this repository. Thanks again for your
contributions, and we look forward to reviewing them!

## Before writing a new DX Tech Paper

Prior to submitting a pull request here with your draft a DX Tech Paper,
see [DX Tech Paper 1](https://peps.python.org/pep-0001/#start-new-paper) for
some important steps to consider, including proposing and discussing it
first in an appropriate venue, drafting a PEP and gathering feedback,
and developing at least a prototype reference implementation of your
idea.

## Contributing changes to existing DX Tech Papers

In general, most non-Draft/Active DX Tech Papers are considered to be historical
documents rather than living specifications or documentation. Major
changes to their core content usually require a new PEP, while smaller
modifications may or may not be appropriate, depending on the PEP\'s
status.
See [PEP Maintenance](https://peps.python.org/pep-0001/#pep-maintenance) and
[Changing Existing
PEPs](https://peps.python.org/pep-0001/#changing-existing-peps) in PEP 1
for more.

Copyediting and proofreading Draft and Active PEPs is welcome (subject
to review by the PEP author), and can be done via pull request to this
repo. Substantive content changes should first be proposed on PEP
discussion threads. We do advise against PRs that simply mass-correct
minor typos on older PEPs which don\'t significantly impair meaning and
understanding.

If you\'re still unsure, we encourage you to reach out first before
opening a PR here. For example, you could contact the PEP author(s),
propose your idea in a discussion venue appropriate to the PEP (such as
[Typing Discourse](https://discuss.python.org/c/typing/) for static
typing, or [Packaging
Discourse](https://discuss.python.org/c/packaging/) for packaging), or
[open an issue](https://github.com/python/peps/issues).

## Opening a pull request

The PEPs repository defines a set of pull request templates, which
should be used when opening a PR.

If you use Git from the command line, you may be accustomed to creating
PRs by following the URL that is provided after pushing a new branch.
**Do not use this link**, as it does not provide the option to populate
the PR template.

However, you *can* use the `gh` command line tool. `gh pr create` will
allow you to create a pull request, will prompt you for the template you
wish to use, and then give you the option of continuing editing in your
browser.

Alternatively, after pushing your branch, you can visit
<https://github.com/python/peps>, and follow the link in the
notification about recent changes to your branch to create a new PR. The
in-browser interface will allow you to select a PR template for your new
PR.

## Commit messages and PR titles

When adding or modifying a PEP, please include the PEP number in the
commit summary and pull request title. For example,
`PEP NNN: <summary of changes>`. Likewise, prefix rendering
infrastructure changes with `Infra:`, linting alterations with `Lint:`
and other non-PEP meta changes, such as updates to the
Readme/Contributing Guide, issue/PR template, etc., with `Meta:`.

## Sign the Contributor License Agreement

All contributors need to sign the [PSF Contributor
Agreement](https://www.python.org/psf/contrib/contrib-form/). to ensure
we legally accept your work.

You don\'t need to do anything beforehand; go ahead and create your pull
request, and our bot will ping you to sign the CLA if needed. [See the
CPython devguide](https://devguide.python.org/pullrequest/#licensing)
for more information.

## Code of Conduct

All interactions for this project are covered by the [PSF Code of
Conduct](https://www.python.org/psf/codeofconduct/). Everyone is
expected to be open, considerate, and respectful of others, no matter
their position within the project.

## Run pre-commit linting locally

You can run this repo\'s basic linting suite locally, either on-demand,
or automatically against modified files whenever you commit your
changes.

They are also run in CI, so you don\'t have to run them locally, though
doing so will help you catch and potentially fix common mistakes before
pushing your changes and opening a pull request.

This repository uses the [pre-commit](https://pre-commit.com/) tool to
install, configure and update a suite of hooks that check for common
problems and issues, and fix many of them automatically.

If your system has `make` installed, you can run the pre-commit checkers
on the full repo by running `make lint`. This will install pre-commit in
the current virtual environment if it isn\'t already, so make sure
you\'ve activated the environment you want it to use before running this
command.

Otherwise, you can install pre-commit with

``` bash
python -m pip install pre-commit
```

(or your choice of installer), and then run the hooks on all the files
in the repo with

``` bash
pre-commit run --all-files
```

or only on any files that have been modified but not yet committed with

``` bash
pre-commit run
```

If you would like pre-commit to run automatically against any modified
files every time you commit, install the hooks with

``` bash
pre-commit install
```

Then, whenever you `git commit`, pre-commit will run and report any
issues it finds or changes it makes, and abort the commit to allow you
to check, and if necessary correct them before committing again.

## Check and fix PEP spelling

To check for common spelling mistakes in your PEP and automatically
suggest corrections, you can run the codespell tool through pre-commit
as well.

Like the linters, on a system with `make` available, it can be installed
(in the currently-activated environment) and run on all files in the
repository with a single command, `make spellcheck`.

For finer control or on other systems, after installing pre-commit as in
the previous section, you can run it against only the files you\'ve
modified and not yet committed with

``` bash
pre-commit run --hook-stage manual codespell
```

or against all files with

``` bash
pre-commit run --all-files --hook-stage manual codespell
```
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# Developer Experince Tech Papers
# Developer Experience Tech Papers

[![DX Tech Papers Build Status](https://github.com/python/peps/actions/workflows/render.yml/badge.svg)](https://github.com/python/peps/actions)
[![DX Tech Papers Syntax Status](https://github.com/devpasta/papers/actions/workflows/syntax.yml/badge.svg)](https://github.com/devpasta/papers/actions)

The DX Tech Papers in this repository are automatically published on the web at [https://dxtechpapers.example.org/](https://dxtechpapers.example.org/). To learn more about the purpose of DX Tech Papers and how to write one, please start reading at [DX Tech Paper 1](https://dxtechpapers.example.org/dx-0001/). Note that the DX Tech Paper Index ([DX Tech Paper 0](https://dxtechpapers.example.org/dx-0000/)) is automatically generated based on the metadata headers in other DX Tech Papers.
The DX Tech Papers in this repository are automatically published on the web at [https://devpasta.github.io/papates/](https://devpasta.github.io/papates/).
To learn more about the purpose of DX Tech Papers and how to write one, please start reading at [DX Tech Paper 1](https://devpasta.github.io/papers/dx-0001/).
Note that the DX Tech Paper Index ([DX Tech Paper 0](https://devpasta.github.io/papers/dx-0000/)) is automatically generated based on the metadata headers in other DX Tech Papers.

## Canonical Links

The canonical form of DX Tech Paper links are zero-padded, such as `https://dxtechpapers.example.org/dx-0008/`. Shortcut redirects are also available. For example, `https://dxtechpapers.example.org/8` redirects to the canonical link.
The canonical form of DX Tech Paper links are zero-padded, such as `https://devpasta.github.io/papers/dx-0008/`. Shortcut redirects are also available. For example, `https://devpasta.github.io/papers/8` redirects to the canonical link.

## Contributing to DX Tech Papers

See the [Contributing Guidelines](./CONTRIBUTING.rst).
See the [Contributing Guidelines](./CONTRIBUTING.md).

## Checking DX Tech Paper Formatting and Rendering

Expand Down
12 changes: 12 additions & 0 deletions papers/dx-0000.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: default
title: DX-0000
parent: DX Tech Papers
permalink: /dx-0000/
nav_order: 1
---

# DX-0000



2 changes: 1 addition & 1 deletion papers/dx-0001.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: DX-0001
parent: DX Tech Papers
permalink: /dx-0001.html
permalink: /dx-0001/
nav_order: 1
---

Expand Down
2 changes: 1 addition & 1 deletion papers/dx-0002.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: DX-0002
parent: DX Tech Papers
permalink: /dx-0002.html
permalink: /dx-0002/
nav_order: 2
---

Expand Down

0 comments on commit e71c91e

Please sign in to comment.