Skip to content

Conversation

@Alan-Jowett
Copy link
Member

This pull request introduces comprehensive documentation for contributing, development, governance, and testing in the BPF Performance project. The new documents establish clear guidelines and processes for contributors and maintainers, covering coding standards, review and approval workflows, and testing methodologies. These resources are designed to improve project quality, maintainability, and community collaboration.

Contribution and Community Guidelines:

  • Added a detailed CONTRIBUTING.md outlining how to report bugs, submit patches, propose new features, and the contributor license agreement process. It also references the project's code of conduct and development practices.
  • Added docs/Governance.md to define project roles (contributors, maintainers), pull request review and approval requirements, issue management, release process, and decision-making protocols.

Development Standards:

  • Added docs/DevelopmentGuide.md specifying coding conventions, header file practices, style guide (including automated formatting and license headers), naming conventions, and testing requirements for code changes.

Testing Framework and Best Practices:

  • Added docs/TestingGuide.md describing the project's approach to performance, unit, integration, and regression testing. It details test organization, data requirements, running tests locally and in CI, guidelines for new tests, metrics collection, and troubleshooting strategies.

Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>
@Alan-Jowett Alan-Jowett merged commit 22a2111 into microsoft:main Nov 12, 2025
20 checks passed
@Alan-Jowett Alan-Jowett deleted the cla branch November 12, 2025 19:53
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.

1 participant