[DOC] Update the guidelines on linked issues/PRs

Open
#134 1 comment 0 reactions 0 assignees View on GitHub

@MrIridescent is already working on this.

Since Feb 20, 2026.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
github

Research direction

No file or test is named in the issue; first locate the documentation section covering linked issues and pull requests. Done means the guidance explains using the Development section in the right-hand sidebar to link issues and pull requests, alongside the existing mention of "closes #issue number".

Written by the indexing model from the issue text.

Description

documentation good first issue

The mention of "closes #issue number" is not always reliable in cases where the specific formatting is not matched.
We should add a sentence on using the "development" section in the right hand menu bar to properly link issues and pull requests.

Dominant language
Python
Stars
3
Forks
2
Avg merge
3d 23h
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from pyfar/gallery

All issues in pyfar/gallery

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.