Contributing to Layout LABS

We're thrilled that you're interested in contributing to Layout LABS! This document provides guidelines for contributing to our custom UI web development tool. By participating in this project, you agree to abide by its terms.

Table of Contents

• Contributing to Layout LABS
  • Table of Contents
  • Code of Conduct
  • Getting Started
  • How Can I Contribute?
    • Reporting Bugs
    • Suggesting Enhancements
    • Code Contributions
  • Style Guidelines
  • Commit Messages
  • Pull Requests
  • Reporting Bugs
  • Suggesting Enhancements
  • Community

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [maintainer's email].

Getting Started

1. Fork the repository on GitHub
2. Clone your fork locally
3. Set up the development environment (see Development Setup)
4. Create a new branch for your contribution
5. Make your changes
6. Push your changes to your fork on GitHub
7. Submit a pull request to the main repository

How Can I Contribute?

Reporting Bugs

• Use the issue tracker to report bugs
• Describe the issue in detail, including steps to reproduce
• Include your environment details (OS, browser version, etc.)

Suggesting Enhancements

• Use the issue tracker to suggest enhancements
• Clearly describe the feature and its potential benefits
• Discuss possible implementations

Code Contributions

• Work on open issues, especially those labeled 'good first issue' or 'help wanted'
• Improve documentation
• Add new features or enhance existing ones
• Fix bugs
• Optimize performance

Style Guidelines

• Follow the JavaScript Style Guide
• Use meaningful variable and function names
• Write clear comments and documentation
• Ensure your code is accessible and follows best practices for web development

Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line

Pull Requests

1. Ensure your code adheres to the style guidelines
2. Include tests for new features or bug fixes
3. Update documentation as necessary
4. Describe your changes in detail in the pull request description
5. Link any relevant issues
6. Be prepared to discuss your changes and make adjustments if necessary

Reporting Bugs

When reporting bugs, please include:

• A clear and descriptive title
• Detailed steps to reproduce the bug
• Expected behavior
• Actual behavior
• Screenshots if applicable
• Your environment details

Suggesting Enhancements

When suggesting enhancements, please include:

• A clear and descriptive title
• Detailed description of the proposed feature
• Any potential implementation details
• Why this enhancement would be useful to most users

Community

• Join our Discord server for discussions
• Follow us on Twitter for updates
• Send us a mail at ai.layoutlabs@gmail.com

Thank you for contributing to Layout LABS😊👌🪴!