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

481 - Improving readability and reproducibility of the repo #514

Merged
merged 9 commits into from
Oct 21, 2024

Conversation

mxochicale
Copy link
Contributor

@mxochicale mxochicale commented Oct 15, 2024

Description

Fixes #481: Improving readability and reproducibility, including:

  • Fixed templates for issues and PR
  • Adds .pre-commit-config.yaml with schemas/github-issue-forms.json to check templates
  • Adds note for links that are not open to the public by essentially requesting access with a new issue
  • Adds collapsed sections to improve readability of main README

Type of change

Please delete options accordingly to the description.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Suggested Checklist

  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have passed on my local host device. (see further details at the CONTRIBUTING document)
  • Make sure your branch is up-to-date with main branch. See CONTRIBUTING for a general example to syncronise your branch with the main branch.
  • I have requested PR review to UCLH-Foundtry/arc-dev
  • I have addressed and marked as resolved all the review comments in my PR.
  • Finally, I have selected squash and merge

Copy link

codecov bot commented Oct 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.32%. Comparing base (4ab7d06) to head (6514400).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #514   +/-   ##
=======================================
  Coverage   87.32%   87.32%           
=======================================
  Files          76       76           
  Lines        3440     3440           
=======================================
  Hits         3004     3004           
  Misses        436      436           

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

Copy link
Contributor

@stefpiatek stefpiatek left a comment

Choose a reason for hiding this comment

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

Couple of suggestions and tweaks

.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yaml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yaml Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
@stefpiatek stefpiatek enabled auto-merge (squash) October 21, 2024 08:38
@stefpiatek stefpiatek merged commit 82ed836 into main Oct 21, 2024
11 checks passed
@stefpiatek stefpiatek deleted the 481-readability-reproducibility branch October 21, 2024 08:50
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.

Few bits to improve readability and reproducibility
2 participants