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

Fix typo in updated deps #2392

Closed
wants to merge 1 commit into from
Closed

Conversation

bgigous
Copy link

@bgigous bgigous commented Oct 26, 2023

Please check if the PR fulfills these requirements

See how to contribute

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Other

What is the current behavior?

N/A

What is the new behavior?

N/A

Does this PR introduce a breaking change, and is titled accordingly?

No breaking changes

Other information

This is a simple typo fix to one of the license YAML files. No testing or docs update were necessary (to my knowledge).

Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

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

Thanks for taking the time to submit this pull request @bgigous!

We can't accept this change because this is automatically generated text that originates from the content of a separate project:

https://github.com/go-git/go-git/blob/v5.4.2/utils/binary/read.go#L1

You'll be glad to learn that the typo has already been fixed in the upstream project:

go-git/go-git#836

That fix will be automatically applied to the generated file here in the Arduino CLI repository when the go-git dependency is bumped to the version that contains the fix (#2390).

@per1234 per1234 self-assigned this Oct 26, 2023
@per1234 per1234 added topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project labels Oct 26, 2023
@per1234
Copy link
Contributor

per1234 commented Oct 27, 2023

@bgigous you are very welcome to submit pull requests to fix typos in the content of this project.

Static Documentation Content

A good place to start is the documentation content:

https://github.com/arduino/arduino-cli/tree/master/docs

Command Reference

The project source code is also fair game. The most important prose content is the command and flag descriptions you will find in the packages here:

https://github.com/arduino/arduino-cli/tree/master/internal/cli

You might find it more convenient to start by reviewing the published content under the "Command reference" section of the documentation website, which is generated from the source code:

https://arduino.github.io/arduino-cli/dev/commands/arduino-cli/

After identifying a typo in the website content, you can then track it back to the source code and make the fix there.

gRPC Reference

The second most important prose content in the source code is the gRPC documentation you will find in the .proto files here:

https://github.com/arduino/arduino-cli/tree/master/rpc/cc/arduino/cli

You might find it more convenient to start by reviewing the published content under the "gRPC reference" section of the documentation website, which is generated from the source code:

https://arduino.github.io/arduino-cli/dev/rpc/commands/

After identifying a typo in the website content, you can then track it back to the source code and make the fix there.

Go Package Reference

The third most important prose content in the source code is the Go "doc comments" in the exported packages.

You might find it more convenient to start by reviewing the published package documentation content, which is generated from the doc comments in the source code:

https://pkg.go.dev/github.com/arduino/arduino-cli

After identifying a typo in the website content, you can then track it back to the source code and make the fix there.

@per1234 per1234 closed this Oct 27, 2023
@per1234 per1234 added the conclusion: invalid Issue/PR not valid label Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: invalid Issue/PR not valid topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants