Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 1.66 KB

contributing.md

File metadata and controls

61 lines (47 loc) · 1.66 KB
Raw

Contributing to LayoutContainer Component

Here are some guidelines to help you get started.

Table of Contents

  1. Getting Started
  2. Development
  3. Code Style
  4. Submitting Changes

Getting Started

  1. Clone the repository to your local machine: 
    git clone https://github.com/sitecorelabs/sitecore-xmcloud-components-layout-container
  2. Navigate to the project directory: 
    cd sitecore-xmcloud-components-layout-container
  3. Install the dependencies: 
    npm install

Development

The main component you will be working on is located in the src/components directory.

  • src/components/LayoutContainer.tsx: Main React component.
  • src/components/assets/sass/layout-container/index.scss: Main SCSS file for styling.
  • src/components/assets/sass/layout-container/_functions.scss: SCSS functions.
  • src/components/assets/sass/layout-container/_variables.scss: SCSS variables.

Code Style

We use ESLint and Prettier to maintain code quality and consistency. Please make sure your code adheres to the style guidelines by running:

npm run lint

Submitting Changes

  1. Create a new branch for your feature or bugfix: 
    git checkout -b feature/your-feature-name
  2. Make your changes and commit them with a clear and descriptive commit message: 
    git commit -m "Add feature: your feature description"
  3. Push your changes to repository: 
    git push origin feature/your-feature-name
  4. Open a pull request against the main repository.

Thank you for your contributions!