Skip to content

chore: add open-source project files (license, security, CI) - #12

Merged
christiangda merged 1 commit into
mainfrom
chore/add-public-lib-files
Jul 11, 2026
Merged

chore: add open-source project files (license, security, CI)#12
christiangda merged 1 commit into
mainfrom
chore/add-public-lib-files

Conversation

@christiangda

Copy link
Copy Markdown
Contributor

Rounds out the repository with the standard files expected of a public open-source Go library, mirroring the setup used in slashdevops/httpx.

What's added

  • LICENSE — Apache-2.0.
  • SECURITY.md — security policy pointing at CodeQL scanning and how to report vulnerabilities.
  • .github/workflows/codeql.yml + .github/codeql/codeql-config.yml — CodeQL Advanced code scanning (Go + Actions) on push/PR to main and a weekly schedule.
  • .golangci.yaml — golangci-lint v2 configuration.
  • DEVELOPMENT_GUIDELINES.md + .github/copilot-instructions.md — contributor/development guidelines.
  • .github/FUNDING.yml — funding links.
  • .github/dependabot.yml — weekly gomod and github-actions dependency updates.

README

  • Removed the Go Report Card badge (the service has been retired). The remaining badges (Go Reference, go.mod version, license, Release) are unchanged.

All existing files were left untouched; go build and go vet pass.

…badges

- Add Apache-2.0 LICENSE
- Add SECURITY.md with CodeQL scanning policy
- Add CodeQL Advanced workflow and config for code scanning
- Add DEVELOPMENT_GUIDELINES.md and .github/copilot-instructions.md
- Add .golangci.yaml linter configuration
- Add .github/FUNDING.yml and dependabot.yml (gomod + github-actions)
- README: drop retired Go Report Card badge
@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@christiangda christiangda self-assigned this Jul 11, 2026
@christiangda
christiangda merged commit 40412fb into main Jul 11, 2026
4 checks passed
@christiangda
christiangda deleted the chore/add-public-lib-files branch July 11, 2026 12:57
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.

2 participants