Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
164 lines (111 loc) · 5.55 KB

CONTRIBUTION.md

File metadata and controls

164 lines (111 loc) · 5.55 KB

Contributing to Siemens Industrial Experience Docs

Thank you for your interest in contributing! This documentation site supports the Siemens Industrial Experience (IX) design system. We welcome improvements to docs, blog posts, scripts, and plugins.

📋 Table of Contents

  1. Prerequisites
  2. How to Contribute
  3. Getting Started
  4. Development Workflows
  5. Pull Request Process
  6. Code of Conduct
  7. Additional Resources

Prerequisites

Before contributing, ensure you have the required tokens and permissions:

GitHub Token

A valid GITHUB_TOKEN is required to build or start the documentation site (pnpm start / pnpm build). This token accesses artifacts from the siemens/ix repository, which contains the source code and example implementations that are downloaded during the build process to provide live code examples and previews in the documentation.

Important for Contributors:

  • Examples (code and preview) are automatically provided via artifacts from the siemens/ix repository during the start and build process
  • If your contribution depends on new or updated examples from the siemens/ix repo, those changes must be merged into the main branch of siemens/ix before your documentation PR can be built and reviewed.
  • Non-maintainers should ensure their example changes are accepted upstream first, then reference them in their documentation PR here.

Figma API Token (Optional)

For updating Figma design assets, you'll need a FIGMA_API_TOKEN with appropriate permissions.

Environment Setup

Create a .env file in the project root with the required tokens:

GITHUB_TOKEN=your-github-token-here
FIGMA_API_TOKEN=your-figma-api-token-here  # Optional, only for Figma updates

How to Contribute

There are several ways to contribute to this project:

  • 🐛 Report Issues: Use GitHub Issues for bugs, suggestions, or feature requests.
  • 📝 Improve Documentation: Spot errors or outdated info? Please update and submit corrections.
  • 📖 Add Blog Posts: Share insights, tutorials, or announcements via blog posts.
  • 🔧 Enhance Scripts/Plugins: Improve tooling in scripts/ or plugins/ directories.
  • 💡 Share Examples: Add use cases or demos to help others.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/ix-docs.git
cd ix-docs
  3. Install dependencies: 
    pnpm install
  4. Set up environment (see Prerequisites for token setup).
  5. Create a branch for your changes: 
    git checkout -b my-feature-branch
  6. Make your changes following the patterns below.

Development Workflows

Documentation Changes

  • Edit or add Markdown files in docs/
  • Component docs follow this structure:
    • docs/components/[component-name]/index.md - Basic headline information
    • docs/components/[component-name]/guide.md - Design system usage and guidelines
    • docs/components/[component-name]/code.mdx - Development examples and APIs
  • Test locally: pnpm start

Blog Posts

  • Create blog/YYYY-MM-DD-title/index.md with images in the same folder
  • Follow existing post structure and frontmatter

Scripts and Plugins

  • Update files in scripts/ or plugins/ as needed
  • Test changes with pnpm build and pnpm start

Testing Your Changes

Updating Figma Images

If you need to refresh Figma design assets:

  1. Ensure you have a valid FIGMA_API_TOKEN in your .env file (see Prerequisites).

  2. Update all Figma images in Markdown files:

    pnpm update-figma '**/*.md?(x)'

  3. Or update specific files:

    pnpm update-figma 'docs/components/button/guide.md'

  4. Commit the updated images and references as part of your PR.

The script downloads new images and replaces outdated ones in the static/figma/ directory based on Figma asset references in your docs.

Pull Request Process

  1. Prepare your changes:

    • Ensure your changes build successfully (pnpm build)
    • Test locally with pnpm start
    • Run linting (pnpm lint)

  2. Commit and push:

    git add .
git commit -m "Clear description of your changes"
git push origin my-feature-branch

  3. Open a Pull Request on GitHub:

    • Clearly describe your changes in the PR description
    • Reference related issues (e.g., Closes #123)
    • For major changes, discuss via an issue first

  4. Review process:

    • Respond to review feedback promptly
    • Make requested changes and push updates
    • Your PR will be merged once approved

Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming environment for all contributors.

Additional Resources

For troubleshooting Figma integration or advanced usage, see the comments in plugins/figma-pictures/figma.ts and related scripts.