Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.6 KB

File metadata and controls

72 lines (49 loc) · 2.6 KB

Contributing to CEF

CEF is a volunteer-driven open source project. Contributions of all kinds are welcome — bug reports, feature requests, code changes, unit tests, and documentation improvements. All contributions are made under the BSD license.

Please use the CEF Forum for general usage questions, not the issue tracker.

Reporting Issues

Search for existing issues before creating new ones. Each issue should:

  • Include the CEF revision or binary distribution version.
  • Include your OS and compiler version.
  • For bugs, provide detailed steps to reproduce the problem.
  • For features, describe why the feature is beneficial.

Vote for issues that are important to you. This helps with development prioritization.

Report security vulnerabilities privately via GitHub Security Advisories. Do not file security issues in the public issue tracker.

Development Setup

See the Branches and Building page for instructions on downloading and building CEF source code. The Master Build Quick-Start guide covers the fastest path to a working build.

Submitting Changes

Create or find an appropriate issue for each distinct bug, feature, or change. For large or architectural changes, discuss the approach in the issue before starting work. Then submit a pull request.

Branch Targets

Submit changes against the current CEF master branch unless explicitly fixing a bug that only occurs in a release branch.

Code Style

Follow the style of existing CEF source files. CEF uses the Chromium C++ style guide.

Commit Messages

Use the imperative present tense: "Fix crash in X" not "Fixed crash in X" or "Fixes crash in X". Keep the first line under 72 characters. Add a blank line before any extended description.

Tests

Include new or modified unit tests as appropriate to the functionality. Bug fixes should include a test that would have caught the bug.

Keep Changes Focused

Each pull request should address a single concern. Do not bundle unrelated refactoring, cosmetic changes, or feature work into the same submission.

AI Policy

The use of AI and LLM tools is permitted under the conditions described in AI_POLICY.md.