Skip to content

Improve documentation, add examples, and modernize CI workflows#5

Merged
arran4 merged 1 commit intomainfrom
improve-docs-and-ci-1352783081704879614
Jan 26, 2026
Merged

Improve documentation, add examples, and modernize CI workflows#5
arran4 merged 1 commit intomainfrom
improve-docs-and-ci-1352783081704879614

Conversation

@google-labs-jules
Copy link
Contributor

This PR addresses several maintenance tasks:

  1. Examples: Added example_test.go with testable examples for the main API functions (ToCamelCase, ToPascalCase, ToKebabCase, ToSnakeCase, ToFormattedCase).
  2. Documentation: Improved godoc comments in types.go and updated README.md with build status badges and license information.
  3. License: Added an MIT LICENSE file.
  4. CI/CD:
    • Renamed go.yml to test.yml and updated actions/setup-go to v5.
    • Created vet.yml for go vet.
    • Created golangci-lint.yml for linting.
    • Created fmt.yml to enforce code formatting.
  5. Formatting: Ran go fmt which slightly updated types_test.go.

PR created automatically by Jules for task 1352783081704879614 started by @arran4

- Create example_test.go with usage examples.
- Add comments to exported types and functions in types.go.
- Add LICENSE file (MIT).
- Update README.md with badges and license info.
- Rename .github/workflows/go.yml to test.yml and update to setup-go@v5.
- Create .github/workflows/vet.yml.
- Create .github/workflows/golangci-lint.yml.
- Create .github/workflows/fmt.yml.
@google-labs-jules
Copy link
Contributor Author

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@arran4 arran4 merged commit 4adf267 into main Jan 26, 2026
0 of 4 checks passed
@arran4 arran4 deleted the improve-docs-and-ci-1352783081704879614 branch January 26, 2026 05:08
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.

1 participant