You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update docs to reference main instead of develop (#1634)
#### Metadata
* Reference Issue: Fixes#1549
* New Tests Added: NA
* Documentation Updated: Yes
* Change Log Entry: Updated `PULL_REQUEST_TEMPLATE.md`, `CONTRIBUTING.md`, and `README.md` to reference the `main` branch instead of `develop`.
#### 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.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ To contribute to the openml-python package, follow these steps:
44
44
45
45
0. Determine how you want to contribute (see above).
46
46
1. Set up your local development environment.
47
-
1. Fork and clone the `openml-python` repository. Then, create a new branch from the ``develop`` branch. If you are new to `git`, see our [detailed documentation](#basic-git-workflow), or rely on your favorite IDE.
47
+
1. Fork and clone the `openml-python` repository. Then, create a new branch from the ``main`` branch. If you are new to `git`, see our [detailed documentation](#basic-git-workflow), or rely on your favorite IDE.
48
48
2.[Install the local dependencies](#install-local-dependencies) to run the tests for your contribution.
49
49
3.[Test your installation](#testing-your-installation) to ensure everything is set up correctly.
50
50
4. Implement your contribution. If contributing to the documentation, see [here](#contributing-to-the-documentation).
To test your new contribution, add [unit tests](https://github.com/openml/openml-python/tree/develop/tests), and, if needed, [examples](https://github.com/openml/openml-python/tree/develop/examples) for any new functionality being introduced. Some notes on unit tests and examples:
94
+
To test your new contribution, add [unit tests](https://github.com/openml/openml-python/tree/main/tests), and, if needed, [examples](https://github.com/openml/openml-python/tree/main/examples) for any new functionality being introduced. Some notes on unit tests and examples:
95
95
* If a unit test contains an upload to the test server, please ensure that it is followed by a file collection for deletion, to prevent the test server from bulking up. For example, `TestBase._mark_entity_for_removal('data', dataset.dataset_id)`, `TestBase._mark_entity_for_removal('flow', (flow.flow_id, flow.name))`.
96
96
* Please ensure that the example is run on the test server by beginning with the call to `openml.config.start_using_configuration_for_example()`, which is done by default for tests derived from `TestBase`.
97
97
* Add the `@pytest.mark.sklearn` marker to your unit tests if they have a dependency on scikit-learn.
You can go to the `openml-python` GitHub repository to create the pull request by [comparing the branch](https://github.com/openml/openml-python/compare) from your fork with the `develop` branch of the `openml-python` repository. When creating a pull request, make sure to follow the comments and structured provided by the template on GitHub.
112
+
You can go to the `openml-python` GitHub repository to create the pull request by [comparing the branch](https://github.com/openml/openml-python/compare) from your fork with the `main` branch of the `openml-python` repository. When creating a pull request, make sure to follow the comments and structured provided by the template on GitHub.
113
113
114
114
**An incomplete contribution** -- where you expect to do more work before
115
115
receiving a full review -- should be submitted as a `draft`. These may be useful
@@ -127,7 +127,7 @@ in the PR description.
127
127
128
128
The preferred workflow for contributing to openml-python is to
129
129
fork the [main repository](https://github.com/openml/openml-python) on
130
-
GitHub, clone, check out the branch `develop`, and develop on a new branch
130
+
GitHub, clone, check out the branch `main`, and develop on a new branch
131
131
branch. Steps:
132
132
133
133
0. Make sure you have git installed, and a GitHub account.
@@ -148,7 +148,7 @@ local disk:
148
148
3. Switch to the ``develop`` branch:
149
149
150
150
```bash
151
-
git checkout develop
151
+
git checkout main
152
152
```
153
153
154
154
3. Create a ``feature`` branch to hold your development changes:
@@ -157,7 +157,7 @@ local disk:
157
157
git checkout -b feature/my-feature
158
158
```
159
159
160
-
Always use a ``feature`` branch. It's good practice to never work on the ``main`` or ``develop`` branch!
160
+
Always use a ``feature`` branch. It's good practice to never work on the ``main`` branch!
161
161
To make the nature of your pull request easily visible, please prepend the name of the branch with the type of changes you want to merge, such as ``feature`` if it contains a new feature, ``fix`` for a bugfix, ``doc`` for documentation and ``maint`` for other maintenance on the package.
162
162
163
163
4. Develop the feature on your feature branch. Add changed files using ``git add`` and then ``git commit`` files:
OpenML-Python provides an easy-to-use and straightforward Python interface for [OpenML](http://openml.org), an online platform for open science collaboration in machine learning.
@@ -94,7 +94,7 @@ Bibtex entry:
94
94
We welcome contributions from both new and experienced developers!
95
95
96
96
If you would like to contribute to OpenML-Python, please read our
0 commit comments