Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (48 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

65 lines (48 loc) · 1.5 KB

Contributing to CMS Auto Margin Component

Thank you for your interest in contributing to this project! Here's how you can help:

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your feature or bug fix
git clone https://github.com/YOUR_USERNAME/cmsLWComponent.git
cd cmsLWComponent
git checkout -b feature/your-feature-name

Setting Up Development Environment

Prerequisites

  • Node.js and npm
  • Salesforce CLI (sfdx or sf)
  • Visual Studio Code with Salesforce Extensions

Installation

npm install
sfdx plugins:install @salesforce/cli

Making Changes

  1. Make your changes in a feature branch
  2. Test thoroughly in a Salesforce scratch org
  3. Ensure your code follows best practices:
    • Use meaningful variable and function names
    • Add comments for complex logic
    • Follow Salesforce coding standards
    • Test your changes

Submitting a Pull Request

  1. Push your changes to your fork
  2. Submit a Pull Request with a clear description of:
    • What problem does it solve?
    • How does it solve it?
    • Any breaking changes?
  3. Respond to code review feedback

Code Standards

  • Use ESLint for JavaScript
  • Use consistent formatting
  • Add JSDoc comments for public methods
  • Write test cases when possible

Reporting Issues

If you find a bug, please create an issue with:

  • Clear title and description
  • Steps to reproduce
  • Expected vs. actual behavior
  • Salesforce org setup if relevant

Thank you for contributing!