Prepare repository for public open-sourcing

[Hinne1]

Summary

• Scrub internal IPs, company-specific index/field names, and NegSoft references from source code, CLI help text, and README
• Add standard open-source files: LICENSE (MIT), CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md
• Add CI workflows (lint, test, coverage, multi-platform build) and tag-triggered release workflow
• Add dependabot config for github-actions and gomod ecosystems
• Update .gitignore and Makefile to match public repo standards
• Update installation instructions from private SSH to public go install

Test plan

• grep -rn '10\.11\.' . returns zero matches (no internal IPs)
• grep -rn 'NegSoft' . --include='*.go' --include='*.md' returns zero matches
• grep -rn 'Müller\|DocumentNo\|CustomerName\|DocumentStateId' . --include='*.go' --include='*.md' returns zero matches
• enthus only appears in GitHub org URLs and Go import paths
• make build succeeds
• LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY files present
• .github/workflows/ and .github/dependabot.yml present

[gemini-code-assist]

Summary of Changes

Hello @Hinne1, I'm Gemini Code Assist¹! 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 transitions the project from an internal tool to a public open-source repository. The changes focus on removing proprietary information, establishing community standards through new documentation, and setting up robust CI/CD pipelines and dependency management. The overall impact is to make the project accessible, maintainable, and welcoming for external contributors.

Highlights

• Open-Source Readiness: The repository has been prepared for public open-sourcing by scrubbing internal IPs, company-specific index/field names, and proprietary references from the codebase, CLI help text, and README.
• Standard Open-Source Files Added: New standard open-source files have been added, including LICENSE (MIT), CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md, to establish clear guidelines for community engagement and project governance.
• CI/CD and Dependency Management: Continuous Integration (CI) workflows for linting, testing, coverage, and multi-platform builds have been introduced, alongside a tag-triggered release workflow. Dependabot configuration for GitHub Actions and Go modules has also been added to automate dependency updates.
• Build System and Documentation Updates: The .gitignore and Makefile have been updated to align with public repository standards, and installation instructions in the README.md have been revised to use public go install instead of private SSH access.

Changelog

• .github/dependabot.yml
  • Added Dependabot configuration for GitHub Actions and Go modules.
• .gitignore
  • Expanded ignored files to include common build artifacts, IDE files, and Go-specific directories.
• CODE_OF_CONDUCT.md
  • Added a Code of Conduct to promote a welcoming community.
• CONTRIBUTING.md
  • Added contribution guidelines for developers.
• LICENSE
  • Added the MIT License.
• Makefile
  • Updated Makefile to include all and help targets, expanded clean command, and optimized LDFLAGS for Go builds.
• README.md
  • Updated installation instructions to use public go install and HTTPS for cloning.
  • Replaced internal IP addresses and company-specific example data with generic placeholders.
  • Added a license section.
• SECURITY.md
  • Added a security policy for reporting vulnerabilities.
• internal/cmd/config/config.go
  • Replaced internal IP addresses in config add examples with generic hostnames.
• internal/cmd/root.go
  • Removed company-specific branding from the CLI short description.
  • Updated example commands to use generic index and field names.
• internal/cmd/search/search.go
  • Updated example search queries and source field examples to use generic index and field names.

Ignored Files

• Ignored by pattern: .github/workflows/** (2)
  • .github/workflows/go.yml
  • .github/workflows/release.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. ↩

[gemini-code-assist]

Code Review

This pull request does an excellent job of preparing the repository for open-sourcing by scrubbing internal references, adding standard community files like LICENSE and CONTRIBUTING.md, and improving the build configuration. The changes are thorough and well-executed. I've only found a couple of minor instances in documentation and examples where a company-specific index name was missed during the scrubbing process. Overall, this is a great step towards making the project public.