Contributing

Thank you for your interest in contributing to ShopsBuilder documentation!

How to Contribute

Setting Up Locally

1. Clone the repository:

   git clone https://git.the-devs.com/virtual-shops/docs/customer-docs.git
   cd customer-docs

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

4. Open http://localhost:3000  to see your changes.

Workflow

Branch-Based Development

All features must be created via branches. Do not push directly to main.

1. Create a new branch for your work:

   git checkout -b feature/your-feature-name
   # or
   git checkout -b fix/your-bugfix-name

2. Make your changes and test locally.

3. Run linters (see Linting below).

4. Commit your changes with clear messages:

   git add .
   git commit -m "feat: add new section about X"
   # or
   git commit -m "fix: correct typo in API docs"

5. Push your branch:

   git push origin feature/your-feature-name

6. Create a merge request in GitLab.

Commit Message Convention

We use semantic commit messages:

• feat: - New features
• fix: - Bug fixes
• docs: - Documentation changes
• style: - Code style changes (formatting)
• refactor: - Code refactoring
• test: - Adding or updating tests
• chore: - Maintenance tasks

Examples:

• feat: add OpenClaw integration guide
• fix: correct API endpoint URL
• docs: update contribution guidelines

Adding Documentation

Adding Agent Documentation

When contributing agent documentation:

1. Create the .mdx file in src/content/
2. Follow the existing content structure
3. Include clear examples and code snippets
4. Update src/content/_meta.js to add the page to navigation

Example agent doc structure:

# Agent Name
 
Brief description of what this agent does.
 
## Capabilities
 
- Capability one
- Capability two
 
## Usage
 
How to use this agent.
 
## Example
 
\`\`\`javascript
// Code example
\`\`\`

General Documentation Rules

• Keep pages focused and scannable
• Use headings to organize content
• Include code examples when applicable
• Add links to related pages
• Test all links before submitting

Linting

Before pushing, run linters to ensure code quality:

# Run all linters
npm run lint

Available Lint Commands

• npm run lint - Run all linters
• npm run lint:js - Check JavaScript/JSX files
• npm run lint:md - Check Markdown files

Linter Errors

If linting fails, fix the reported issues before pushing. CI will block merge requests with lint errors.

Regular Pushes

Push your work regularly to avoid losing progress. Small, focused commits are preferred over large, monolithic changes.

Suggested Commit Frequency

• Push after completing a logical unit of work
• Push at least daily when working on a feature
• Push after fixing bugs or issues

Merge Request Process

1. Ensure all lint checks pass
2. Update the CHANGELOG.md with your changes
3. Create a merge request with:
   • Clear title (e.g., feat: Add OpenClaw integration)
   • Description of what was changed and why
   • Screenshots for UI changes (if applicable)
4. Request review from the team

Code of Conduct

Be respectful to all contributors. Constructive feedback helps us improve.

Questions?

If you have questions about contributing, reach out to the team via GitLab issues or the development team chat.