astropy / astropy/astroquery

DOC: explain changelog in devdocs

Open
#3,229 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

- changelog needs the number of the PR not the issue
- we don't changelog docs/test changes or any internal restructure that has no effect to the users (not a bugfix or a performance improvement)
- we don't changelog follow-up PRs of new features if they are not yet released ("affect-dev"), but may amend the original changelog entry with the number of the new PR.

Contributor guide

Open the contributing guide

Research direction

Start in the devdocs changelog guidance and review the three rules stated in the issue: use the PR number, omit non-user-facing changes, and handle unreleased feature follow-ups appropriately. Done means the devdocs clearly explain these cases and match the wording and examples expected by the project.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.