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

Joss response #77

Merged
merged 7 commits into from
Jun 15, 2022
Merged

Joss response #77

merged 7 commits into from
Jun 15, 2022

Conversation

thomaspinder
Copy link
Collaborator

This PR updates the repository's README file to explicitly guide new users through the contribution process. It also introduces a pre-commit hook to black format and sort imports.

Pull request type

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

It is currently a requirement that formatting be done manually by the user upon committing code. This can lead to incocistencies when people use different formatting options or forget to pre-format code.

Further, there is no acknowledgement to how new users can contribute to GPJax from with the repository's README.

Issue Number: #76

What is the new behavior?

A pre-commit hook is introduced to automate code formatting. A section of text has been introduced into the repository's README file to signpost new users to the relevant parts of the repository for contributing, raising issues, or starting discussions.

@codecov
Copy link

codecov bot commented Jun 15, 2022

Codecov Report

Merging #77 (2d3d8e4) into master (0a26a9f) will increase coverage by 0.36%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #77      +/-   ##
==========================================
+ Coverage   98.71%   99.08%   +0.36%     
==========================================
  Files          13       13              
  Lines         859      871      +12     
==========================================
+ Hits          848      863      +15     
+ Misses         11        8       -3     
Flag Coverage Δ
unittests 99.08% <ø> (+0.36%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
gpjax/gps.py 100.00% <0.00%> (ø)
gpjax/types.py 100.00% <0.00%> (ø)
gpjax/sparse_gps.py
gpjax/variational.py
gpjax/variational_inference.py 95.65% <0.00%> (ø)
gpjax/variational_families.py 100.00% <0.00%> (ø)
gpjax/likelihoods.py 100.00% <0.00%> (+4.47%) ⬆️

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 0a26a9f...2d3d8e4. Read the comment docs.

@thomaspinder thomaspinder mentioned this pull request Jun 15, 2022
2 tasks
@thomaspinder thomaspinder merged commit 97ab331 into master Jun 15, 2022
@thomaspinder thomaspinder deleted the joss_response branch June 15, 2022 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants