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

Update user guides and implement branch name prefix enforcement #110

Merged
merged 15 commits into from
Oct 13, 2023

Conversation

huong-li-nguyen
Copy link
Contributor

@huong-li-nguyen huong-li-nguyen commented Oct 12, 2023

Description

  • Update user guides for custom charts, custom components and deployment
  • Implement pre-commit-hook for branch prefix enforcement

Note: Current regex pattern ensures that the branch name starts with one of the specified prefixes, followed by a slash, and then allows for any combination of characters, numbers, slashes, dots, etc. after -> I've double checked that our automatic release branch names pass

Screenshot

Checklist

  • I have not referenced individuals, products or companies in any commits, directly or indirectly
  • I have not added data or restricted code in any commits, directly or indirectly
  • I have updated the docstring of any public function/class/model changed
  • I have added the PR number to the change description in the changelog fragment, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1)) (if applicable)
  • I have added tests to cover my changes (if applicable)

Types of changes

  • Docs/refactoring (non-breaking change which improves codebase)
  • 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 change)

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.

@huong-li-nguyen huong-li-nguyen self-assigned this Oct 12, 2023
@huong-li-nguyen huong-li-nguyen added the Docs 🗒️ Issue for markdown and API documentation label Oct 12, 2023
@huong-li-nguyen huong-li-nguyen changed the title Update user guides and implement branch prefix enforcement Update user guides and implement branch name prefix enforcement Oct 12, 2023
Copy link
Contributor

@maxschulz-COL maxschulz-COL left a comment

Choose a reason for hiding this comment

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

Looks good, some small suggestions

vizro-core/docs/pages/user_guides/custom_charts.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/custom_charts.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/custom_components.md Outdated Show resolved Hide resolved
Copy link
Contributor

@maxschulz-COL maxschulz-COL left a comment

Choose a reason for hiding this comment

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

🚀

@huong-li-nguyen huong-li-nguyen merged commit b773153 into main Oct 13, 2023
15 checks passed
@huong-li-nguyen huong-li-nguyen deleted the docs/update_guides_custom branch October 13, 2023 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 🗒️ Issue for markdown and API documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants