Skip to content

docs: add AGENTS.md for project overview and working rules - #5087

Merged
Frozen merged 1 commit into
devfrom
feature/agents-file
Jul 30, 2026
Merged

docs: add AGENTS.md for project overview and working rules#5087
Frozen merged 1 commit into
devfrom
feature/agents-file

Conversation

@Frozen

@Frozen Frozen commented Jul 25, 2026

Copy link
Copy Markdown
Collaborator

This pull request adds a new AGENTS.md file at the repository root, providing clear guidelines for contributors and automated agents. The document outlines the project's scope, working rules, recommended commands, build notes, and documentation standards to ensure consistency and security across contributions.

Contributor guidelines:

  • Added AGENTS.md with repository-wide instructions on code changes, including scope, formatting, testing, and security-sensitive areas.
  • Documented useful Go and Makefile commands for building, testing, and maintaining the project.
  • Included best practices for running checks, build steps, and documentation updates before completing a pull request.
  • Specified requirements for pull request descriptions, including a [Test] section summarizing validation steps and results.

@Frozen
Frozen changed the base branch from main to dev July 25, 2026 05:02
@Frozen Frozen self-assigned this Jul 25, 2026
@Frozen
Frozen force-pushed the feature/agents-file branch from a2bb59c to 1e450fa Compare July 28, 2026 07:00
@Frozen

Frozen commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator Author

@copilot AGENTS.md contains actual information?

Copilot AI commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

@copilot AGENTS.md contains actual information?

Yes — the file contains real, repository-specific information:

  • Project overview: describes Harmony as a Go blockchain node, its main executables (node + bootnode), and the specific Go version (1.24.2) and BLS dependency (github.com/herumi/bls-eth-go-binary) used.
  • Working rules: concrete conventions like formatting with gofmt/goimports, security-sensitive areas (consensus, cryptography, staking, slashing), and restrictions like not editing generated files directly.
  • Useful commands: exact make targets (make exe, make go-vet, make go-test, make protofiles, make debug, etc.) and targeted go test/go vet patterns.
  • Build notes: guidance on fetching the BLS dependency (go mod download or make libs) and caveats around Docker/native libraries for full test runs.
  • Documentation and PR standards: requirement for a [Test] section in PR descriptions.

The content is intended to guide both human contributors and AI coding agents working in this repository.

@mergify

mergify Bot commented Jul 30, 2026

Copy link
Copy Markdown

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@Frozen
Frozen merged commit f7240df into dev Jul 30, 2026
12 checks passed
@Frozen
Frozen deleted the feature/agents-file branch July 30, 2026 01:33
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.

3 participants