Skip to content

Prepare repository for public open-source release#5

Merged
fank merged 4 commits intomainfrom
claude/open-source-readiness
Feb 17, 2026
Merged

Prepare repository for public open-source release#5
fank merged 4 commits intomainfrom
claude/open-source-readiness

Conversation

@fank
Copy link
Copy Markdown
Member

@fank fank commented Feb 17, 2026

Summary

  • Fix license mismatch between LICENSE (MIT) and README.md (was "MIT + Commons Clause")
  • Remove Makefile, replace with direct go commands in CONTRIBUTING.md and README.md
  • Add CI workflow (build, test, lint) on push/PR to main
  • Add issue templates (bug report, feature request) and PR template

Repo settings also updated

  • Description: "CLI for managing n8n workflows"
  • Topics: n8n, cli, go, workflow, automation
  • Wiki: disabled

Test plan

  • Verify CI workflow runs on this PR
  • Review templates render correctly on GitHub
  • Confirm README and CONTRIBUTING instructions are accurate

Fix license mismatch (README said MIT + Commons Clause, LICENSE is MIT),
replace Makefile with direct go commands, add CI workflow, issue templates,
and PR template.
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @fank, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on preparing the repository for public open-source release by standardizing development practices, clarifying licensing, and improving the contributor experience. It streamlines the build process, enhances contribution guidelines, and sets up automated quality checks to ensure a smooth and consistent development workflow.

Highlights

  • License Correction: The license description in README.md was updated to correctly reflect the MIT License, resolving a mismatch with the LICENSE file.
  • Build Process Streamlining: The Makefile was removed, and build, test, lint, and format commands in CONTRIBUTING.md and README.md were updated to use direct go or golangci-lint commands.
  • Developer Workflow Enhancements: New issue templates for bug reports and feature requests, along with a pull request template, were added to standardize contributions.
  • CI/CD Integration: A CI workflow for build, test, and lint checks on push and pull requests to main was introduced.
Changelog
  • .github/ISSUE_TEMPLATE/bug_report.md
    • Added a new template for reporting bugs, including sections for description, steps to reproduce, expected/actual behavior, and environment details.
  • .github/ISSUE_TEMPLATE/feature_request.md
    • Added a new template for suggesting features or improvements, outlining sections for problem, proposed solution, and alternatives.
  • .github/PULL_REQUEST_TEMPLATE.md
    • Added a new template for pull requests, providing sections for summary, changes, and testing instructions.
  • CONTRIBUTING.md
    • Updated build, test, lint, and format commands from make commands to direct go and golangci-lint commands.
    • Modified the pre-commit check instructions to use golangci-lint run && go test ./... instead of make lint && make test.
    • Changed the code style formatting instruction from make fmt to go fmt ./....
  • Makefile
    • Removed the entire Makefile, eliminating make commands for build, install, clean, test, lint, fmt, cross-compilation, and release tasks.
  • README.md
    • Updated the local build instruction from make build to go build -o bin/n8nctl ./cmd/n8nctl.
    • Corrected the license description from 'MIT + Commons Clause' to 'MIT License' to align with the actual license file.
Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/ci.yml
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request prepares the repository for its public open-source release by adding issue templates, a pull request template, and updating documentation. The Makefile has been removed in favor of direct go commands in the README.md and CONTRIBUTING.md files to simplify the contribution process. The license information has also been corrected for consistency. My review focuses on ensuring the new development instructions are complete and consistent. I've suggested re-adding the version information to local builds via ldflags and ensuring consistency in the test commands.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread README.md Outdated
fank added 3 commits February 17, 2026 10:30
Pin golangci-lint to v2.9.0 (v1.x built with Go 1.24 < project's 1.25),
add ldflags for version injection in build commands, add -v to test command.
@fank fank merged commit 31ed76c into main Feb 17, 2026
2 checks passed
@fank fank deleted the claude/open-source-readiness branch February 17, 2026 09:37
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