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

Rename "master" to "main" throughout the project #278

Merged
merged 7 commits into from Nov 24, 2021
Merged

Conversation

leouieda
Copy link
Member

Update the default branch name is CI and testing. The default in the
Pooch class remains "master" for backwards compatibility and won't be
changed until v2.0. Updated the links to our guides as well.

Fixes #276

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

Update the default branch name is CI and testing. The default in the
`Pooch` class remains "master" for backwards compatibility and won't be
changed until v2.0. Updated the links to our guides as well.
Copy link
Member

@santisoler santisoler left a comment

Choose a reason for hiding this comment

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

Looks great, hope we don't break any package that depends on Pooch 🤞🏼.

I've just replaced "master" for "main" on CONTRIBUTING.md and MAINTENANCE.md.
We are still defaulting to "master" on pooch.create(), which is good so we keep backwards compatibility. We should deprecate that in the future and change the default to "main".

@leouieda leouieda merged commit c2b43e6 into main Nov 24, 2021
@leouieda leouieda deleted the no-more-masters branch November 24, 2021 05:33
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.

Rename the default branch to "main"
2 participants