Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
139 lines (98 loc) · 7.14 KB

CONTRIBUTING.md

File metadata and controls

139 lines (98 loc) · 7.14 KB

Contributing Guide For B2C Developer Tooling, B2C-CLI, B2C DX MCP, B2C Tooling SDK

This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to B2C Developer Tooling. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes.

Governance Model

Salesforce Sponsored

The intent and goal of open sourcing this project is to increase the contributor and user base. However, only Salesforce employees will be given admin rights and will be the final arbitrars of what contributions are accepted or not.

Getting started

Please join the community on Salesforce Commerce Cloud Unofficial slack.

Issues, requests & ideas

Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.

Bug Reports and Fixes

  • If you find a bug, please search for it in the Issues, and if it isn't already tracked, create a new issue. Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still be reviewed.
  • Issues that have already been identified as a bug (note: able to reproduce) will be labelled bug.
  • If you'd like to submit a fix for a bug, send a Pull Request and mention the Issue number.
  • Include tests that isolate the bug and verifies that it was fixed.

New Features

  • If you'd like to add new functionality to this project, describe the problem you want to solve in a new Issue.
  • Issues that have been identified as a feature request will be labelled enhancement.
  • If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, enhancements may not align well with the project objectives at the time.

Tests, Documentation, Miscellaneous

  • If you'd like to improve the tests, you want to make the documentation clearer, you have an alternative implementation of something that may have advantages over the way its currently done, or you have any other change, we would be happy to hear about it!
  • If its a trivial change, go ahead and send a Pull Request with the changes you have in mind.
  • If not, open an Issue to discuss the idea first.

If you're new to our project and looking for some way to make your first contribution, look for Issues labelled good first contribution.

Running the MCP server from source

For information on running the MCP server from source and local development, see packages/b2c-dx-mcp/CONTRIBUTING.md.

Contribution Checklist

  • Clean, simple, well styled code
  • Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
  • Comments
    • Module-level & function-level comments.
    • Comments on complex blocks of code or algorithms (include references to sources).
  • Tests
    • The test suite, if provided, must be complete and pass
    • Increase code coverage, not versa.
  • Dependencies
    • Minimize number of dependencies.
    • Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.
  • Reviews
    • Changes must be approved via peer code review

Changesets

This project uses Changesets to manage versions and changelogs.

When to Add a Changeset

Add a changeset when your PR includes changes that users should know about:

  • Bug fixes
  • New features
  • Breaking changes
  • Significant improvements

For documentation-only changes (new guides, restructured content, significant improvements) that should be deployed before the next package release, create a changeset targeting @salesforce/b2c-dx-docs. This triggers a doc-only release and rebuild. Routine doc fixes (typos, minor clarifications) that can wait for the next package release don't need a changeset.

You don't need a changeset for:

  • Internal refactoring
  • Test improvements
  • CI/build changes

How to Add a Changeset

  1. Run the changeset command:

    pnpm changeset

  2. Select the packages affected by your change (usually all three are linked)

  3. Choose the change type:

    • patch - Bug fixes, minor improvements
    • minor - New features, non-breaking changes
    • major - Breaking changes

  4. Write a brief summary of your change (this appears in the changelog)

  5. Commit the generated .changeset/*.md file with your PR

Release Process

When changesets are merged to main, an automated PR is created that bumps versions and updates changelogs. This release PR requires approval from the B2C Developer Experience team before it can be merged. Once merged, packages are published automatically.

Notes

  • Changesets are optional - maintainers can add them later if needed
  • Multiple changesets can exist for separate changes
  • For release branches (urgent patches while unrelated changesets are pending on main, or maintenance patches on older minors), see PUBLISHING.md for details
  • See PUBLISHING.md for full release process details

Creating a Pull Request

  1. Ensure the bug/feature was not already reported by searching on GitHub under Issues. If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress).
  2. Clone the forked repo to your machine.
  3. Create a new branch to contain your work (e.g. git br fix-issue-11)
  4. Commit changes to your own branch.
  5. Push your work back up to your fork. (e.g. git push fix-issue-11)
  6. Submit a Pull Request against the main branch and refer to the issue(s) you are fixing. Try not to pollute your pull request with unintended changes. Keep it simple and small.
  7. Sign the Salesforce CLA (you will be prompted to do so when submitting the Pull Request)

NOTE: Be sure to sync your fork before making a pull request.

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Salesforce's open source projects.

Complete your CLA here: https://cla.salesforce.com/sign-cla

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Code of Conduct

Please follow our Code of Conduct.

License

By contributing your code, you agree to license your contribution under the terms of our project LICENSE and to sign the Salesforce CLA