Raising Issues

Raising Issues

An issue is an area where you feel the project could be improved. For example, you could report a problem or bug you’ve encountered while using the software or a gap in the project’s documentation.

When raising issues via our GitHub repository, ensure you state the issue clearly using the provided issue templates. A high-quality report includes:

  • A clear, descriptive title.

  • Full description of steps to reproduce the behaviour.

  • The version(s) of SuiteCRM the issue was found in.

  • Environment details (PHP version, Database version, Web server).

  • Relevant log entries from suitecrm.log or your PHP error logs.

Clear reporting allows contributors and the maintainers to easily identify, reproduce, and address the issue.

Security

We take security seriously at SuiteCRM Ltd. If you believe you have found a security vulnerability in our software, please report it to us.

Please don’t disclose security bugs publicly until they have been handled and patched by the security team.

See our Security Policy for more details.

GitHub Labels

Labels help the community and the SuiteCRM Ltd team categorise and prioritise work. You can click the labels below to see the current list of issues on GitHub.

Common Issue Labels

Type: Bug Confirmed or highly likely to be a functional bug.

Priority: Critical

Issues that cause data loss or completely break the application.

Priority: Important

High-impact issues that affect core business processes.

Priority: Moderate

Standard bugs that have practical workarounds.

Status: Fix Proposed

Issues that have an associated Pull Request already in progress or suggested fix.

Area: Language

Issues relating specifically to translations or language files.

Type: Suggestion

Requests for new features or enhancements. Please use community Forum Suggestion Box for general suggestions and feature requests.

Pull Request Labels

Status: Assessed

PRs that have been assessed by a core team member as ready for code review and testing.

Status: Requires Code Review

Contributions that need Code reviewed before being tested

Status: Requires Testing

Contributions that need testing before moving to Ready to Merge.

Status: Ready to Merge

Code that has passed functional assessment and technical code review.

Content is available under GNU Free Documentation License 1.3 or later unless otherwise noted.