Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 10.9 KB

CONTRIBUTING.md

File metadata and controls

115 lines (81 loc) · 10.9 KB

How to contribute to SuiteCRM

Code of Conduct

This project and all community members are expected to uphold the SuiteCRM Code of Conduct.

Bug Reporting

  • Please do not open a GitHub issue if the bug is a security vulnerability, and instead email us at security@suitecrm.com. This will be delivered to the product team who handle security issues. Please don't disclose security bugs publicly until they have been handled by the security team.

  • Your email will be acknowledged within 24 hours during the business week (Mon - Fri), and you’ll receive a more detailed response to your email within 72 hours during the business week (Mon - Fri) indicating the next steps in handling your report.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue that relates to your problem, open a new one. Please be sure to follow the issue template as much as possible.

  • Ensure that the bug you are reporting is a core SuiteCRM issue and not specific to your individual setup. For these types of issues please use the Community Forum.

Did you fix a bug?

  • To provide a code contribution for an issue you will need to set up your own fork of the SuiteCRM repository, make your code changes, commit the changes and make a Pull Request to the appropriate branch on the SuiteCM repository. See our Quick Guide to Fork SuiteCRM. Once you have set up your forked repository you can begin making commits to the project.

  • Determine which base branch your bug fix should use. If your bug is present in both hotfix and hotfix-7.8.x then you will need to make a seperate pull request for each branch.

  • Separate each fix into a new branch in your repository and name it with the issue ID e.g. bugfix_3062 or issue-1234.

  • When committing to your individual bugfix branch, please try and use the following as your commit message Fixed #1234 - <the subject of the issue>. E.g. Fixed #1436 - Reports with nested Parentheses are removing parameters. By using this format we can easily include all bug fixes within major and minor release notes on our Wiki.

  • If you are new to Writing Commit Messages in git, follow the guide here.

  • After you have made your commits and pushed them up to your forked repository you then create a Pull Request to be reviewed and merged into the SuiteCRM repository. Make a new Pull Request for each issue you fix – do not combine multiple bugfixes into one Pull Request. Ensure that your Pull Request fork is salesagility/SuiteCRM, base branch is either hotfix or hotfix-7.8.x, the head fork is your repository, and the base branch is your unique bugfix branch e.g. bugfix_1234. We will automatically reject any Pull Requests made to the wrong branch!

  • If you have not signed our CLA Contributor License Agreement then your pull request will fail a check and we will be unable to merge it into the project. You will only be required to sign this once.

  • When a new Pull Request is opened, Travis CI will test the merging of the origin and upstream branch and update the Pull Request. If this check fails you can review the test results and resolve accordingly. To test prior to making a Pull Request install PHPUnit via composer into your develop environment then cd into the tests directory and run: $ sh runtests.sh

  • Ensure that you follow the pull request template as much as possible.

Did you create a new feature or enhancement?

  • Changes that can be considered a new feature or enhancement should be made to the develop branch instead of the hotfix or hotfix-7.8.x. branch.

  • To contribute a feature to SuiteCRM, similar to providing a Bug Fix, you must create a forked repository of SuiteCRM and set up your git and development environment. Once done, create a new branch from develop and name it relevant to the feature's purpose e.g campaign-wizard-ui. Following our Code Standards, develop the new feature and ensure your forked repository is kept up to date with minor/major releases. See our Quick Guide to Fork SuiteCRM to update your repository. Make sure your commit messages are relevant and descriptive. When ready to submit for review, make a Pull Request detailing your feature's functionality. Ensure that your Pull Requests base fork is salesagility/SuiteCRM, the base branch is develop, the head fork is your repository, and the base branch is your feature branch. Add any new PHPUnit tests to the new feature branch if required e.g new modules or classes.

Issue and Pull Request Labels

  • This section lists the labels we use to help us track and manage issues and pull requests across the SuiteCRM repositories.

  • By using GitHub search you can use labels to help find issues and pull requests that you are interested in. If for example, you are interested in which PR's will be included in the next release of SuiteCRM, you can use the open issues "Resolved: Next Release" label.

  • We encourage users whom feel an issue should be raised as a higher priority for a next release that they should make a comment to that affect. This also applies to incorrect labelling.

Types of Issue Labels

Label name salesagility/SuiteCRM Description
bug search Confirmed or very likely to be a bug.
Low Priority search Low impact (e.g. visual only, typos, alignments).
Medium Priority search Medium impact blocker with a workaround.
High Priority search A high impact blocker with no workaround.
Fix Proposed search Issues with a related pull request.
Pending Input search Pending input from issue raiser.
language search Issues relating to language files
suggestion search Suggestions that will later be moved to Trello
question search General questions (Should usually be posted to the community forum instead)
Resolved: Next Release search Solved issues that will be closed after the next release.
invalid search Issues that are invalid or non-reproducible.
duplicate search Issues which are duplicates of other issues.

Types of Pull Request Labels

Label name salesagility/SuiteCRM Description
Assessed search Pull requests that have been confirmed to fix the original issue by a SalesAgility member.
Ready to Merge search Pull requests that have both been assessed and code reviewed by SalesAgility.
Needs Tests search Pull requests that require addition acceptance or unit tests before they can be merged.
Community Contribution search Pull requests that have been created by a member of the community.
Enhancement search Pull requests that add additional features or functionality. These pull requests will need to be reviewed by SalesAgility before being merged.
In Review search Currently in-review and requires additional work from creator
Wrong Branch search Pull requests that have been created to the wrong branch.
duplicate search Duplicate of other pull requests.

Thanks!

SuiteCRM Team