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

docs: change mention of master to main in the documentation (Issue #491) #522

Merged
merged 2 commits into from
Feb 19, 2023

Conversation

Jimmy-Vu
Copy link
Contributor

Description

This pull request includes changes made by @CatherineNjenga in pull request #507, as well as my own changes to remove an outdated warning blob in the Contributing section of README.md (as requested in this comment). @CatherineNjenga's changes include updating all mention of "master" to "main" in the documentation.

With @jwu910's approval, I have squashed and merged @CatherineNjenga's commits into one and reworded the commit message to follow the commitizen conventions.

Fixes #491

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist:

  • I have read the CONTRIBUTING document.
  • My commits follow the commitizen commit convention
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

CatherineNjenga and others added 2 commits February 18, 2023 15:54
All mentions of master are changed to main in the documentation to stay up-to-date with the master branch being renamed to main.

BREAKING CHANGE:🧨  N/A

✅ Closes: 491
The warning blob about a branch name change has been removed from the
README file. This warning was added when the repo still had a
development branch, and contributors were asked to send pull requests to
that branch. However, since the development branch has been dropped for
a while now, the warning is no longer relevant.

BREAKING CHANGE: 🧨 N/A

✅ Closes: 491
Copy link
Owner

@jwu910 jwu910 left a comment

Choose a reason for hiding this comment

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

thanks. lgtm

@jwu910 jwu910 merged commit e93fb73 into jwu910:main Feb 19, 2023
@jwu910
Copy link
Owner

jwu910 commented Feb 19, 2023

@all-contributors please add @Jimmy-Vu for docs

@allcontributors
Copy link
Contributor

@jwu910

I've put up a pull request to add @Jimmy-Vu! 🎉

@jwu910
Copy link
Owner

jwu910 commented Feb 19, 2023

@all-contributors please add @CatherineNjenga for docs

@allcontributors
Copy link
Contributor

@jwu910

I've put up a pull request to add @CatherineNjenga! 🎉

@jwu910
Copy link
Owner

jwu910 commented Feb 19, 2023

@all-contributors please add @CatherineNjenga for docs

@allcontributors
Copy link
Contributor

@jwu910

@CatherineNjenga already contributed before to doc

@Jimmy-Vu Jimmy-Vu deleted the CIO-491-update-docs-remove-warning-blob branch February 21, 2023 01:05
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.

Change mentions of master to main in documentation
3 participants