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.

Sign up for GitHub

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

Jump to bottom

Update status badges #441

Merged
merged 2 commits into from
Mar 2, 2021
Merged

Update status badges #441

merged 2 commits into from
Mar 2, 2021

Conversation

rrjbca
Copy link
Contributor

@rrjbca rrjbca commented Mar 1, 2021 •
edited
Loading

Description

See updated README here

  • Add JOSS status badge
  • Move status badges to appropriate subsections in the README to reduce clutter

Checklist

  • Follow the Contributor Guidelines
  • Write unit tests
  • Write documentation strings
  • Assign someone from your working team to review this pull request
  • Assign someone from the infrastructure team to review this pull request

@rrjbca rrjbca added the documentation Improvements or additions to documentation label Mar 1, 2021
@rrjbca rrjbca requested a review from a team March 1, 2021 12:04
@ntessore
Copy link
Member

ntessore commented Mar 1, 2021

  • no point in adding the JOSS badge unless it's accepted
  • I get the urge to remove clutter, but the entire point of the badges is to have them at the top of the README for a quick glance. Instead of moving them you might as well remove them and replace with a blurb of text.

@rrjbca
Copy link
Contributor Author

rrjbca commented Mar 1, 2021

The JOSS badge would update on being accepted (which I recognise could not happen). Regarding clutter the specific issue I had was that adding JOSS made the badges spill over onto a second line on my screen. They do also seem to split naturally into groups; DOIs, Distributions, and Testing (+Docs?). Probably preferable to keep the DOI badges on the front page though rather than getting lost in the CITATION page.

@rrjbca
Copy link
Contributor Author

rrjbca commented Mar 1, 2021

Perhaps let's keep the PR open and reconsider merging once the JOSS paper is published?

@ntessore
Copy link
Member

ntessore commented Mar 1, 2021

In the end, now with the badges under individual headlines, it is easily identifiable on the actual page so happy to accept once JOSS goes through. Or we accept it now and own our loss in case it doesn't get accept.

ntessore
ntessore approved these changes Mar 2, 2021
View reviewed changes
Copy link
Member

@ntessore ntessore left a comment

Choose a reason for hiding this comment

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

I decided that I like the Under Review badge, so good to go for me.

@rrjbca rrjbca merged commit fad2b76 into skypyproject:main Mar 2, 2021
@rrjbca rrjbca deleted the joss_badge branch March 2, 2021 14:07
itrharrison added a commit that referenced this pull request Dec 15, 2022
@itrharrison @rrjbca
@ntessore @Lucia-Fonseca @sutieng @philipp128 @Fox-Davidson
MAINT: merge main into module/halos (#581)
3496ac0 
* Update name of default branch to main (#434)

* update mailmap (#432)

* Write all tables to a single FITS/HDF5 file (#425)

* ADR 3: Position sampling and patches of the sky (#422)

* BUG: Raise ImportError if optional dependency speclite is not installed (#437)

* MAINT: Set NumPy latest supported version to 1.20 #440

* Update status badges (#441)

* MAINT: Update Lucia affiliation (#451)

* MAINT: add SIT's information (#450)

* DOC: Fix contributor guidelines link (#449)

Co-authored-by: Richard R <[email protected]>
Co-authored-by: Nicolas Tessore <[email protected]>

* ENH: Logging for skypy command line script and Pipeline class (#453)

* DOC: Describe speclite filters in documentation (#457)

* ENH: Config syntax for importing objects (#463)

* DOC: List of Features (#456)

* DOC: How to construct config files (#454)

* DOC: Remove docstring examples (#429)

* MAINT: Update Zenodo entry for RPR (#468)

* DOC: Readme updates (#460)

* DOC: Expanded landing page documentation (#228)

* DOC: Inverse transform sampling accuracy warning (#472)

* MAINT: Set astropy latest supported version to 4.2 (#483)

* DOC: zenodo json members update (#481)

* DOC: Ryden04 ellipticity doc missing section (#477)

* MAINT: Update numpy and scipy latest supported versions (#488)

* BUG: Change invalid ecsv datatype from int to uint16 (#485)

* DEV: setuptools==58.0.0 (#493)

Co-authored-by: Nicolas Tessore <[email protected]>

* Add compatibility workflow badge (#487)

* DEV: Enable pip to install pre-releases in the tox dev environments (#491)

* TST: Use tmp_path fixture for temporary files in unit tests (#489)

* BUG: Move handling of context arguments after handling of .depends keyword (#465)

* BLD: Set astropy latest supported version to 4.3 and speclite minversion to 0.14 (#486)

* REV: restore setuptools to latest version on readthedocs (#494)

* DEV: pyparsing<3.0.0 (#500)

* Check new astropy file overwrite error message in logging test (#498)

* REV: restore pyparsing to latest version for doc builds (#501)

* DOC: Update citation file with JOSS paper reference (#496)

* BLD: Set astropy latest supported version to 5.0 (#504)

* BLD: Set python latest supported version to 3.10 (#505)

* BLD: Set numpy latest supported version to 1.22 (#506)

* BLD: Set python oldest supported version to 3.7 (#507)

* DOC: Fix code of conduct link (#508)

* Changed y-label in luminosity function example. (#512)

* BLD: Set scipy latest supported version to 1.8 (#510)

* ENH: Rykoff model of the magnitude uncertainty (#526)

* TST: assert photometric error is numerically close to the analytic value (#545)

* TST: Drop deprecated astropy.tests.helper.raises (#546)

* ENH: compute kcorrect remaining stellar mass (#476)

* compute kcorrect remaining stellar mass

* added test for stellar mass remain

Co-authored-by: Ian Harrison <[email protected]>
Co-authored-by: Lucia F. de la Bella <[email protected]>

* ENH: Logistic completeness function (#521)

* BLD: Set astropy latest supported version to 5.1 (#547)

* BUG: `schechter_smf` callable input and docs (#525)

* DOC: Typo in Rykoff error (#550)

* add Fox's details (#551)

Co-authored-by: Richard R <[email protected]>

* BLD: Set numpy latest supported version to 1.23 (#552)

* codestyle fixes

* add six requirement for colossus

* tried to fix docs builds

* update passenv

* rtd configuration

Co-authored-by: Richard R <[email protected]>
Co-authored-by: Nicolas Tessore <[email protected]>
Co-authored-by: Lucia F. de la Bella <[email protected]>
Co-authored-by: Sut-Ieng Tam <[email protected]>
Co-authored-by: philipp128 <[email protected]>
Co-authored-by: Fox Davidson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ntessore ntessore ntessore approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rrjbca @ntessore