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

Update contrib #328

Merged
merged 6 commits into from
Oct 23, 2024
Merged

Update contrib #328

merged 6 commits into from
Oct 23, 2024

Conversation

dc2917
Copy link
Contributor

@dc2917 dc2917 commented Oct 23, 2024

Description

This PR adds some changes to the contributing guidelines, with some missing links added, developer installation command updated and some minor grammar/wording fixes.

Fixes #297

Type of change

  • Documentation (non-breaking change that adds or improves the documentation)
  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass (eg. python -m pytest)
  • The documentation builds and looks OK (eg. python -m sphinx -b html docs docs/build)
  • Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Oct 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.76%. Comparing base (98ec548) to head (8250b3f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #328   +/-   ##
=======================================
  Coverage   86.76%   86.76%           
=======================================
  Files          22       22           
  Lines        2199     2199           
  Branches      280      280           
=======================================
  Hits         1908     1908           
  Misses        214      214           
  Partials       77       77           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dc2917 dc2917 requested a review from barneydobson October 23, 2024 12:18
@barneydobson barneydobson merged commit 1ec99d4 into main Oct 23, 2024
5 checks passed
@barneydobson barneydobson deleted the update_contrib branch October 23, 2024 12:47
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.

udpate contributing
3 participants