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

Added a heading in the client/operations.go file that was missing #11914

Merged
merged 1 commit into from
Jul 4, 2023
Merged

Added a heading in the client/operations.go file that was missing #11914

merged 1 commit into from
Jul 4, 2023

Conversation

ibilalkayy
Copy link
Contributor

Hey there,

There was documentation missing in one function in the client/operations.go file. I added 2 lines of text there to make them understandable.

Thank you!

@tomponline
Copy link
Member

Hi @ibilalkayy thanks for this. It looks like the documentation and dco checks are failing.

@ibilalkayy
Copy link
Contributor Author

@tomponline It's my first time sending the PRs here and I don't know how to pass these checks. What is lacking?

@tomponline
Copy link
Member

@tomponline It's my first time sending the PRs here and I don't know how to pass these checks. What is lacking?

The DCO one says here;

https://github.com/lxc/lxd/actions/runs/5441251213/jobs/9895028225?pr=11914

What should I do to fix it ?
All proposed commits should include a Signed-off-by: line in their commit message.
This is most conveniently done by using --signoff (-s) when running git commit.

@ibilalkayy
Copy link
Contributor Author

ibilalkayy commented Jul 3, 2023

@tomponline Although I visited the contribution guide but I was not able to understand where to sign off these details.

Can you guide me? Thank you!

@tomponline
Copy link
Member

please can you rebase to fix the documentation failure.

@markylaing
Copy link
Contributor

@tomponline Although I visited the contribution guide but I was not able to understand where to sign off these details.

Can you guide me? Thank you!

Hi @ibilalkayy in this case as you just have one commit you can run git commit --amend then edit the commit message. Add a blank line after your original commit message, then add Signed-off-by: {your name} <{your email address}>.

If you run git log on the master branch you should be able to see examples of this. A convenient shortcut to sign commits automatically is the -s commit flag, which will sign commits with your name and email configured via git. For example, you could commit your changes with the following command git commit -sm "client: Adds a comment to the setupListener method."

@ibilalkayy
Copy link
Contributor Author

@markylaing and @tomponline I added the signed-off details in the commit message and pushed it

Copy link
Member

@tomponline tomponline left a comment

Choose a reason for hiding this comment

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

Thanks!

@tomponline tomponline merged commit 1dd7e07 into canonical:master Jul 4, 2023
@ibilalkayy ibilalkayy deleted the doc/operations-headings branch July 4, 2023 12:13
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.

3 participants