Contributing to SFRA

To contribute to the SFRA base cartridge, follow the guidelines below. This helps us address your pull request in a more timely manner.

Conventions for branch names and commit messages

Branch names

To name a branch, use the following pattern: yourusername-description

In this pattern, description is dash-delimited.

For example: jdoe-unify-shipping-isml

Commit messages

To create a commit message, use the following pattern: action-term: short-description

In this pattern, action-term is one of the following:

Bug
Doc
Chore
Update
Breaking
New

After action-term, add a colon, and then write a short description. You can optionally include a GUS ticket number in parentheses.

For example: "Breaking: Unify the single- and multi-ship shipping isml templates (W-999999)."

Submitting your first pull request

If this is your first pull request, follow these steps:

Create a fork of the SFRA repository
Download the forked repository
Checkout the integration branch
Apply your code fix
Create a pull request against the integration branch

Submitting a pull request

Create a branch off the integration branch.
- To reduce merge conflicts, rebase your branch before submitting your pull request.
- If applicable, reference the issue number in the comments of your pull request.
In your pull request, include:
- A brief description of the problem and your solution
- (optional) Screen shots
- (optional) Error logs
- (optional) Steps to reproduce
Grant SFRA team members access to your fork so we can run an automated test on your pull request prior to merging it into our integration branch.
- From within your forked repository, find the 'Settings' link (see the site navigation on left of the page).
- Under the settings menu, click 'User and group access'.
- Add the new user to the input field under the heading 'Users' and give the new user write access.
Indicate if there is any data that needs to be included with your code submission.
Your code should pass the automation process.
- Lint your code:
  npm run lint
- Run and pass the unit test:
  npm run test
- Run and pass the unit/intergration test:
  npm run test:integration

What to expect

After you submit your pull request, we'll look it over and consider it for merging.

As long as your submission has met the above guidelines, we should merge it in a timely manner.

Our sprints run for about two weeks; in that period of time, we typically review all pull requests, give feedback, and merge the request (depending on our current sprint priorities).

Community contributors

To speed up the process of reviewing and merging your pull request, grant the following team members access to your fork:

SFRA team

Contributor License Agreement

All external contributors must sign our Contributor License Agreement (CLA).

Commit signing

All contributors must set up commit signing.

3.6 KiB Raw Blame History

Table of contents