# Contributing to Uniface Element Thank you for your interest in contributing to Uniface Element! We welcome contributions from the community. ## Table of Contents - [Code of Conduct](#code-of-conduct) - [How Can I Contribute?](#how-can-i-contribute) - [Development Setup](#development-setup) - [Coding Standards](#coding-standards) - [Commit Guidelines](#commit-guidelines) - [Pull Request Process](#pull-request-process) ## Code of Conduct - Be respectful and inclusive - Provide constructive feedback - Focus on what is best for the community - Show empathy towards other community members ## How Can I Contribute? ### Reporting Bugs Before creating bug reports, please check existing issues to avoid duplicates. When creating a bug report, include: - **Title**: Clear and descriptive - **Description**: Detailed explanation of the issue - **Reproduction**: Steps to reproduce the behavior - **Expected behavior**: What you expected to happen - **Environment**: OS, browser, Node.js version, package version - **Screenshots**: If applicable, add screenshots ### Suggesting Enhancements Enhancement suggestions are welcome! Please include: - **Use case**: What problem would this solve? - **Proposed solution**: How should it work? - **Alternatives**: What alternatives have you considered? - **Impact**: Who would benefit from this feature? ### Pull Requests Pull requests are the best way to propose changes. Here's how to submit one: 1. Fork the repository 2. Create a branch for your feature or bugfix 3. Make your changes following our coding standards 4. Write tests for your changes (if applicable) 5. Ensure all tests pass 6. Commit your changes with clear messages 7. Push to your fork and submit a pull request ## Development Setup ### Prerequisites - Node.js >= 18.0.0 - npm >= 8.0.0 ### Installation ```bash # Clone your fork git clone https://github.com/your-username/uniface-element.git cd uniface-element # Install dependencies npm install # Start development server npm run dev ``` ### Build and Test ```bash # Type check npm run check # Build the library npm run build # Run linting npm run lint # Format code npm run format # Run security audit npm run audit ``` ## Coding Standards ### TypeScript - Use TypeScript for all new code - Avoid using `any` type - Provide proper type definitions for props and events - Use interfaces for object shapes ### Svelte Components - Follow Svelte best practices - Use `