Skip to content

Comments

chore: prepare repository for open source release#2

Merged
fank merged 2 commits intomainfrom
feature/NX-0-open-source-readiness
Feb 17, 2026
Merged

chore: prepare repository for open source release#2
fank merged 2 commits intomainfrom
feature/NX-0-open-source-readiness

Conversation

@fank
Copy link
Member

@fank fank commented Feb 17, 2026

Summary

  • Add GitHub issue templates (bug report, feature request) for structured community contributions
  • Add PR template with testing checklist
  • Remove Makefile in favor of standard Go tool commands (go build, go test, golangci-lint)
  • Update README.md and CONTRIBUTING.md to reflect the new workflow

Test plan

  • Verify issue templates render correctly on GitHub (Settings > Issues > Templates)
  • Verify PR template appears when opening a new PR
  • Confirm go build ./cmd/esq and go test -race ./... work as documented

@gemini-code-assist
Copy link

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 prepares the repository for open-source collaboration by establishing clear guidelines and streamlining the development environment. It aims to make it easier for new contributors to report issues, suggest features, and submit code by providing structured templates and standardizing build and test commands.

Highlights

  • Community Contribution Templates: Added GitHub issue templates for bug reports and feature requests, along with a pull request template, to standardize community contributions.
  • Simplified Build Workflow: Removed the custom Makefile in favor of standard Go tool commands (go build, go test, golangci-lint) for building, testing, and linting.
  • Documentation Updates: Updated README.md and CONTRIBUTING.md to reflect the new, simplified development workflow and contribution guidelines.
Changelog
  • .github/ISSUE_TEMPLATE/bug_report.yml
    • Added a new YAML-based template for reporting bugs, including fields for description, steps to reproduce, expected behavior, and environment details.
  • .github/ISSUE_TEMPLATE/feature_request.yml
    • Added a new YAML-based template for suggesting features or improvements, with sections for problem description, proposed solution, and alternatives considered.
  • .github/PULL_REQUEST_TEMPLATE.md
    • Added a Markdown template for pull requests, including sections for summary, changes, and a testing checklist.
  • CONTRIBUTING.md
    • Updated the 'Getting Started' section to replace make commands with direct go build, go test, and golangci-lint run commands.
    • Modified the contribution steps to use golangci-lint run && go test -race ./... instead of make lint && make test for pre-commit checks.
  • Makefile
    • Removed the entire Makefile, eliminating custom build, install, clean, lint, and test targets.
  • README.md
    • Removed the 'clone and build' section that used make install.
    • Simplified the PATH instruction to specifically mention ~/go/bin.
    • Updated the 'Development' section to replace make commands with direct go build, go test, and golangci-lint run commands.
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

@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 is a great step towards preparing the repository for an open-source release. The addition of issue and pull request templates will improve the contribution workflow, and standardizing on Go tool commands instead of a Makefile makes the project more accessible. However, the removal of the Makefile has introduced a regression: build-time version injection is lost, which will negatively impact debugging and issue reporting. I have added high-severity comments in README.md and CONTRIBUTING.md to highlight this and suggest solutions. I also included a medium-severity suggestion to improve the new pull request template.

Add GitHub issue templates (bug report, feature request) and PR template.
Remove Makefile in favor of standard Go tool commands.
@fank fank force-pushed the feature/NX-0-open-source-readiness branch from 74d4ee4 to 4b6e972 Compare February 17, 2026 12:53
@fank fank changed the title Prepare repository for open source release chore: prepare repository for open source release Feb 17, 2026
@fank fank merged commit fbb2f86 into main Feb 17, 2026
3 checks passed
@fank fank deleted the feature/NX-0-open-source-readiness branch February 17, 2026 13:01
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