PyGithub / PyGithub/PyGithub

Support GraphQL closingIssuesReferences

Open
#2,567 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7.8k
Forks
1.9k
Avg merge
17m
Merged PRs (30d)
2

Description

Hi there,
the GitHub API supports the concept of closingIssuesReferences (see https://docs.github.com/en/graphql/reference/objects#pullrequest) which is the way to link an issue to be closed automatically when a PR fixes it.

Is it possible to implement it in the PyGithub library as well?

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.

Research direction

Start by locating how PyGithub represents pull requests and exposes GitHub API fields, then compare that path with the GraphQL PullRequest closingIssuesReferences documentation linked in the issue. Add support for retrieving this concept through the library and verify that the resulting pull request data includes the referenced closing issues.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.