Skip to content

docs(agents): guide contributors through repository workflows#3370

Merged
wwbmmm merged 1 commit into
apache:masterfrom
darion-yaphet:support-codex
Jul 5, 2026
Merged

docs(agents): guide contributors through repository workflows#3370
wwbmmm merged 1 commit into
apache:masterfrom
darion-yaphet:support-codex

Conversation

@darion-yaphet

Copy link
Copy Markdown
Contributor

What problem does this PR solve?

Issue Number: resolve N/A

Problem Summary:

The repository’s AGENTS.md only contained a minimal agent/security note. It did not provide practical contributor guidance for repository structure, build and test
workflows, coding style, testing expectations, PR conventions, or security/configuration reminders.

What is changed and the side effects?

Changed:

  • Replaced the minimal agent note with a concise contributor guide tailored to the brpc repository.
  • Documented key source, test, example, tool, documentation, packaging, and binding directories.
  • Added common Make, CMake, Bazel, and example smoke-test commands.
  • Summarized coding style, naming conventions, testing expectations, commit/PR guidance, and security tips.

Side effects:

  • Performance effects: None. Documentation-only change.
  • Breaking backward compatibility: None. No code or build behavior changed.

Check List:

Verification:

  • Ran git diff --check -- AGENTS.md.
  • Build and unit tests were not run because this is a documentation-only change.

Replace the minimal agent note with a concise contributor guide tailored to the brpc repository. The guide captures structure, build and test commands, coding style, testing expectations, PR guidance, and security reminders.
@wwbmmm wwbmmm merged commit 5cdf821 into apache:master Jul 5, 2026
1 check passed
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