Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 3.28 KB

Contributing.md

File metadata and controls

77 lines (58 loc) · 3.28 KB

Contributing

Cacti accepts bug reports, code changes, documentation corrections, and translations. Choose the repository that owns the affected component:

Report a problem

Search the project's open and closed issues before opening a report. Include versions, reproduction steps, expected and actual behavior, and relevant logs. Remove passwords, SNMP communities, tokens, and other sensitive information. See Known Issues for release notes and existing reports. For installation or usage help, use the Cacti Forums.

Report suspected vulnerabilities privately through the Cacti security policy.

Code contributions

Create a branch for one focused change and submit a pull request to the repository that owns it. Use develop unless maintainers request another branch. Check the issue and target branch before starting a maintenance fix; a change needed on one branch may already be fixed on another.

Read the contributor instructions in that branch. In the Cacti development repository, composer.json defines PHP requirements and checks, .nvmrc specifies the Node version, and package-lock.json locks frontend dependencies. For a development checkout, install dependencies from the repository root:

composer install
npm ci

Use the branch's formatter, static analysis, and relevant tests before submitting. The development branch provides composer check; consult its contributor guide for individual commands. Maintenance branches may have different tools. Describe what changed and how you verified it. Add regression coverage when it protects against a realistic failure, and link the associated issue.

Follow the code formatting, PHP, SQL, and security guides. Update relevant documentation and follow the target branch's changelog instructions. See Patch Creation for the submission workflow.

Documentation contributions

Submit manual changes to the documentation repository. Explain the correction and link an existing issue where applicable. Check instructions against the Cacti branch being documented, distinguish released features from development features, and verify commands, links, and images.

Follow the Documentation Standards and link new pages from README.md. Updating this repository does not immediately update the public website; publication depends on the project's documentation build and deployment process.

Translations

Use the translation guide to contribute through Cacti's translation service. Changes to translatable application strings must also update the source message template as described in that guide.


Copyright (c) 2004-2026 The Cacti Group