Skip to content

Conversation

@JemmaLDaniel
Copy link
Collaborator

@JemmaLDaniel JemmaLDaniel commented Jan 5, 2026

PR Type

Documentation


Description

  • Standardize example branch naming to kebab-case

  • Update commit message example to lowercase

  • Align push command examples with branch name change


Changes walkthrough 📝

Relevant files
Documentation
README.md
Standardize examples in README                                                     

README.md

  • Changed feature branch example to kebab-case
  • Updated commit message example to lowercase text
  • Adjusted push command to match branch naming
  • +3/-3     
    contributing.md
    Standardize examples in contributing guide                             

    docs/contributing.md

  • Changed git checkout branch example to kebab-case
  • Updated git commit example to lowercase text
  • Adjusted git push example to match new branch naming
  • +3/-3     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @JemmaLDaniel JemmaLDaniel requested a review from BioGeek January 5, 2026 13:14
    @JemmaLDaniel JemmaLDaniel self-assigned this Jan 5, 2026
    @JemmaLDaniel JemmaLDaniel added the documentation Improvements or additions to documentation label Jan 5, 2026
    @JemmaLDaniel
    Copy link
    Collaborator Author

    /describe

    @instadeep-pr-agent
    Copy link

    PR Description updated to latest commit (ce49166)

    @github-actions
    Copy link

    github-actions bot commented Jan 5, 2026

    Coverage

    Coverage Report
    FileStmtsMissCoverMissing
    __init__.py00100% 
    constants.py80100% 
    data_types.py40100% 
    calibration
       __init__.py00100% 
       calibration_features.py2631195%163–164, 317–319, 546–548, 997–999
       calibrator.py841088%69–70, 95–96, 98, 123–124, 128, 155–156
    datasets
       __init__.py00100% 
       calibration_dataset.py801186%184, 186–187, 193–196, 198–201
       data_loaders.py1901900%7–11, 13–17, 19–20, 24, 27, 30–31, 42, 44, 49, 54, 56–57, 67, 70–71, 73–74, 79, 85–86, 95, 98, 108, 113–114, 124, 129–131, 133, 137–138, 140–141, 146, 149, 156, 162, 164–165, 174, 176–179, 181, 185–186, 188, 190, 192–193, 204–206, 215, 217–218, 230, 236, 245–246, 250, 252–253, 263–264, 267, 270–271, 278, 287, 289, 305–306, 308–310, 312–314, 316–317, 319, 322, 346, 357–358, 364–365, 374–375, 377–378, 387–388, 390–393, 395, 399–400, 402, 404, 420–421, 423–424, 427–429, 434, 437–438, 441–442, 448–449, 451, 453, 463, 466, 478–479, 486, 492, 496, 498, 501, 505, 507, 523, 535, 548–549, 551–552, 555–557, 567–568, 570, 572–574, 576, 587, 589, 600–601, 605, 609, 611, 623, 630, 643, 653–654, 665, 698, 704, 724, 727, 740–741, 743–746, 749, 752, 759, 767–770, 772–773
       interfaces.py330%6–8
       psm_dataset.py250100% 
    fdr
       __init__.py00100% 
       base.py581574%81, 85–86, 91, 98–99, 105, 126, 129–130, 135, 137–138, 144, 186
       database_grounded.py220100% 
       nonparametric.py25484%62, 68–69, 72
    scripts
       __init__.py00100% 
       main.py1371370%2, 9–11, 17–19, 21–30, 34–37, 40, 43–46, 49–50, 53, 56–57, 60–61, 64–65, 68–69, 72–73, 76–77, 80, 83–84, 88–89, 91–93, 95, 103, 119–122, 125, 128–129, 132, 136–137, 140, 144–145, 148, 153, 156, 159, 168–169, 177, 180, 198–200, 205, 212, 217–218, 221, 228–230, 232, 236–241, 244, 246–247, 252–253, 300–301, 306, 309–310, 315, 318–319, 322–324, 327, 331, 385–386, 391, 395–397, 400–401, 403–404, 406–408, 411–414, 422, 424, 430–434, 437, 439–442
    TOTAL89938157% 

    Tests Skipped Failures Errors Time
    126 0 💤 0 ❌ 0 🔥 35.681s ⏱️

    @JemmaLDaniel JemmaLDaniel merged commit 3a6a93e into main Jan 6, 2026
    4 checks passed
    @JemmaLDaniel JemmaLDaniel deleted the 141-fix-use-a-valid-commit-example-in-documentation-contributing-section branch January 6, 2026 08:34
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    documentation Improvements or additions to documentation

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    Fix: Use a valid commit example in documentation 'Contributing' section

    3 participants