python / python/devguide

Add a "what's new" page to the devguide

Open
#885 5 comments 5 reactions 1 assignee View on GitHub

@ezio-melotti is already working on this.

Since Jun 7, 2022.

type-feature
Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Description

During the last docs-community meeting, we discussed the fact that we are currently using several different tools (git, GitHub, Discourse, Discord, etc.) and each tool has a learning curve. Combined with the fact that the tools change and evolve over time, it's difficult for the devs to use them proficiently and effectively.

Documenting how to use them in the devguide is useful, but devs rarely re-read the devguide to discover these new sections. I therefore propose to create a "What's new" page to list significant additions and changes to the devguide, to make these more discoverable.

I think it will also be useful to post these entries with a regular cadence (e.g. monthly) on Discourse, so that people don't have to actively check the "What's new" page and remember when was the last time they checked.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.