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: update the README instructions for running Spanner samples #1266

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

aakashanandg
Copy link

Fixes #<1265> 🦕

@aakashanandg aakashanandg requested review from a team as code owners December 12, 2024 09:01
@product-auto-label product-auto-label bot added size: xs Pull request size is extra small. api: spanner Issues related to the googleapis/python-spanner API. labels Dec 12, 2024
@product-auto-label product-auto-label bot added the samples Issues that are directly related to samples. label Dec 12, 2024
Copy link
Contributor

@olavloite olavloite left a comment

Choose a reason for hiding this comment

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

The change itself LGTM, but the pull request title needs to be changed. We use conventional commits to generate the release notes. This means that:

  1. All commits and pull request titles should start with a commit type (feat:, docs:, fix:, etc.) In this case, the type should be docs:
  2. The rest of the header automatically goes into the release notes, so it should preferably be worded in a way that it reads naturally for someone reading it after it has been released. So in this case I would suggest docs: update the README instructions for running Spanner samples

@aakashanandg aakashanandg changed the title Updating the README in python spanner to include instructions for running spanner samples docs: update the README instructions for running Spanner samples Dec 12, 2024
@aakashanandg
Copy link
Author

The change itself LGTM, but the pull request title needs to be changed. We use conventional commits to generate the release notes. This means that:

  1. All commits and pull request titles should start with a commit type (feat:, docs:, fix:, etc.) In this case, the type should be docs:
  2. The rest of the header automatically goes into the release notes, so it should preferably be worded in a way that it reads naturally for someone reading it after it has been released. So in this case I would suggest docs: update the README instructions for running Spanner samples

Got it! I've updated the PR description to follow the conventional commits guideline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: spanner Issues related to the googleapis/python-spanner API. samples Issues that are directly related to samples. size: xs Pull request size is extra small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants