Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand contribution guidelines #2248

Merged
merged 4 commits into from
Dec 21, 2021
Merged

Conversation

keflavich
Copy link
Contributor

Our contributing guidelines were not explicit about dependencies and timing of PRs, so I suggest we expand those guidelines.

@codecov
Copy link

codecov bot commented Dec 13, 2021

Codecov Report

Merging #2248 (5541815) into main (8a60cd2) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2248      +/-   ##
==========================================
+ Coverage   62.38%   62.40%   +0.02%     
==========================================
  Files         131      131              
  Lines       16775    16777       +2     
==========================================
+ Hits        10465    10470       +5     
+ Misses       6310     6307       -3     
Impacted Files Coverage Δ
astroquery/utils/download_file_list.py 28.12% <0.00%> (+7.15%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8a60cd2...5541815. Read the comment docs.

CONTRIBUTING.rst Outdated
Comment on lines 68 to 69
For example, astropy.table should be used for table handling,
astropy.io.ascii for ascii-table parsing, and astropy.units for unit and quantity
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be convenient to have links to relevant astropy documentation:

Suggested change
For example, astropy.table should be used for table handling,
astropy.io.ascii for ascii-table parsing, and astropy.units for unit and quantity
For example, `astropy.table` should be used for table handling,
`astropy.io.ascii` for ascii-table parsing, and `astropy.units` for unit and quantity

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 - I think we have to link manually, though, not through intersphinx, b/c CONTRIBUTING is rendered by github

Co-authored-by: Eero Vaher <eero.vaher@gmail.com>
CONTRIBUTING.rst Outdated Show resolved Hide resolved
Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
@bsipocz bsipocz merged commit 501e1dd into astropy:main Dec 21, 2021
@bsipocz
Copy link
Member

bsipocz commented Dec 21, 2021

Thanks @keflavich!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants