Skip to content

[MNT] Update documentation to reference main branch instead of develop#1634

Merged
fkiraly merged 2 commits intoopenml:mainfrom
Akarshkushwaha:update-pr-template
Feb 16, 2026
Merged

[MNT] Update documentation to reference main branch instead of develop#1634
fkiraly merged 2 commits intoopenml:mainfrom
Akarshkushwaha:update-pr-template

Conversation

@Akarshkushwaha
Copy link
Contributor

Metadata

Details

  • What does this PR implement/fix? Explain your changes.
    This PR updates the contribution documentation and the PR template to correctly reference the main branch as the default/target branch. The previous documentation incorrectly instructed contributors to use the develop branch, which does not exist in this repository.

  • Why is this change necessary? What is the problem it solves?
    The instructions were outdated for new contributors, as they referred to a non-existent develop branch. This corrects the workflow to align with the repository's actual structure (using main).

  • How can I reproduce the issue this PR is solving and its solution?
    Navigate to the previous version of CONTRIBUTING.md or PULL_REQUEST_TEMPLATE.md and observe the references to develop. Check the repository branches to confirm develop does not exist.

  • Any other comments?
    I have also verified the changes by running pre-commit locally to ensure no formatting issues were introduced.

@Akarshkushwaha Akarshkushwaha changed the title Update documentation to reference main branch instead of develop [MNT] Update documentation to reference main branch instead of develop Feb 15, 2026
@Akarshkushwaha
Copy link
Contributor Author

Hi @PGijsbers @satvshr, I have addressed the issue by updating the PR template, CONTRIBUTING.md, and README to reference main instead of develop. I've also verified the changes with pre-commit. Could you please review? Thanks!

Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

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

Thanks!

@fkiraly fkiraly changed the title [MNT] Update documentation to reference main branch instead of develop [MNT] Update documentation to reference main branch instead of develop Feb 16, 2026
@fkiraly
Copy link
Collaborator

fkiraly commented Feb 16, 2026

quick-merging due to openml hackathon this week, to avoid contributor confusion.

@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.78%. Comparing base (f7014e7) to head (1562d9f).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1634      +/-   ##
==========================================
- Coverage   53.08%   52.78%   -0.30%     
==========================================
  Files          36       36              
  Lines        4357     4357              
==========================================
- Hits         2313     2300      -13     
- Misses       2044     2057      +13     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fkiraly fkiraly merged commit ef242af into openml:main Feb 16, 2026
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MNT] Update PR description template and developer documentation to point to main instead of develop

3 participants