Contribution SLA
This document is an SLA that details the required services and the expected level of services in the process of contributing content to the Cortex XSOAR Marketplace.
#
Options for contributing content to the Cortex XSOAR Marketplace:- Contribute through the Cortex XSOAR UI.
- Contribute through a GitHub Pull Request on the public XSOAR Content Repository. For more information, see How to Contribute.
In each of the above options, a review phase begins with the opening of the GitHub Pull Request containing your content changes.
#
XSOAR Content Team Commitments:Once your PR is open, the XSOAR content team commits to the following:
After opening the PR, a reviewer will be assigned to your PR and will publish the initial response to your changes within 5 business days.
If you are asked to make changes, you need to make those changes, and add a corresponding message in the pull request. Your reviewer will respond within 3 business days. Note: You might have a few rounds of fixes. These commitments are the same for each round.
Your reviewer will be available for any questions during the review process - you can contact them on the PR itself or on slack (DFIR Slack Community).
Once your PR is approved and merged by your reviewer, an internal PR including your changes will be opened within an hour. The internal PR allows us to run our internal validity and security checks on your final code. The internal PR will be merged within 3 business days. Note: If during the internal PR phase we discover issues related to the code changes made in the contribution, the contributor may be asked to help resolve them.
Once the internal PR is merged, your changes will be published in the Cortex XSOAR Marketplace within 3 business days.
#
The Contributor Commitments:For the contribution process to be successful, the XSOAR content team requires the contributors to do the following:
Provide the XSOAR content team with as much information as possible about the changes made or about the new content you created.
- If you contributed through the Cortex XSOAR UI, you need to provide this information in your UI contribution form.
- If you contributed through a GitHub Pull Request, add this information in the PR body (fill in the template).
If you contributed through a GitHub Pull Request you need to register your contribution by filling out the contribution registration form, and sign the CLA (Contributor License Agreement). The review process won't start if those forms remain unfilled.
Links to the Contribution registration form and to the CLA will appear on your PR:
Providing the XSOAR content team with a recorded demo session that demonstrates your changes is much appreciated and will speed up the review process.
- If you contributed through the Cortex XSOAR UI, provide a link to the recorded session in your UI contribution form.
- If you contributed through a GitHub Pull Request, provide it in the contribution registration form.
Please check the status of the build of your PR once it is completed. If the build includes errors, please try to solve them - for more information about the build process, see The Build Process.
During the review process, monitor your PR. Your reviewer will add comments to the PR, asking questions and requesting changes. To establish a decent review process for your contribution, you are kindly asked to respond to the reviewer's code review and apply the required changes within 14 days. Stale Pull Requests might be closed.
- Note: Once your PR is reviewed, add or update only content items that were requested in the review process. If you have any new content items, please open a new PR. When in doubt, consult the reviewer of the PR.
If your contribution includes changes in an XSOAR-supported content pack, you are required to conform to the XSOAR code and documentation standards, and to add unit tests and a test-playbook to test your code. For more information see XSOAR Code Conventions, XSOAR Packs Documentation, Unit-Testing, Test-Playbooks.
In some cases, your reviewer will ask you to schedule a meeting to see an interactive demo. Ensure you have a working installation of Cortex XSOAR with your most recent content pack version (including all review changes) fully configured. Check out our Contribution Demo Page for more details.
While the XSOAR content team strives to merge and publish your changes as quickly as possible, the duration of the review process depends on many factors such as the level of support of the edited content pack, the amount and complexity of your changes, and various validations and security tests. Please understand and be patient.