astropy / astropy/astroquery

DOC: add brief devdocs to contributing.rst and main docs page

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

Description

e.g.
- mention not using merge commits for updating branches

- mention that it's PR number that has to go into the changelog

- adding PR titles that appropriately describe the content (instead of referring to issue numbers). maybe even use prefixes for BUG, ENH, etc.

- no excessive style or infrastructure refactors please. automated PRs are not welcome even if your editor/IDE loves black/ruff/etc. Please set it up to honour our style check, and only style the lines you otherwise touch with your functional/enhancement PR.

Contributor guide

Open the contributing guide

Research direction

Start by reading contributing.rst and the main documentation page to see their existing contributor guidance. Add the requested notes about avoiding merge commits, using the PR number in changelogs, descriptive PR titles, optional BUG/ENH prefixes, and avoiding unrelated style or infrastructure refactors. Done means all listed contribution practices are briefly documented in the requested locations.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.