chore: prepare repository for open source release#2
Conversation
Summary of ChangesHello @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
Changelog
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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.
74d4ee4 to
4b6e972
Compare
Summary
go build,go test,golangci-lint)Test plan
go build ./cmd/esqandgo test -race ./...work as documented