|
| 1 | +# Contributing to launch.css |
| 2 | + |
| 3 | +First of all, thank you for considering contributing to launch.css! This document provides guidelines and instructions to help you contribute effectively. |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | + |
| 7 | +- [Getting Started](#getting-started) |
| 8 | +- [Development Environment](#development-environment) |
| 9 | +- [Making Contributions](#making-contributions) |
| 10 | +- [Coding Standards](#coding-standards) |
| 11 | +- [Pull Request Process](#pull-request-process) |
| 12 | +- [Documentation](#documentation) |
| 13 | + |
| 14 | +## Getting Started |
| 15 | + |
| 16 | +launch.css is a classless CSS framework that aims to help developers build websites quickly without having to worry about styling initially. The project is built with Sass and uses a modular approach to make maintenance and contributions easier. |
| 17 | + |
| 18 | +## Development Environment |
| 19 | + |
| 20 | +### Prerequisites |
| 21 | + |
| 22 | +- Node.js (v22+) |
| 23 | +- pnpm |
| 24 | + |
| 25 | +### Setup |
| 26 | + |
| 27 | +1. Fork the repository |
| 28 | +2. Clone your fork: `git clone https://github.com/YOUR-USERNAME/launch.css.git` |
| 29 | +3. Navigate to the project: `cd launch.css` |
| 30 | +4. Install dependencies: `pnpm install` |
| 31 | +5. Start development: `pnpm dev` |
| 32 | + |
| 33 | +## Making Contributions |
| 34 | + |
| 35 | +### Types of Contributions |
| 36 | + |
| 37 | +- **Bug fixes**: Fixing issues with existing components |
| 38 | +- **New features**: Adding new components or functionality |
| 39 | +- **Documentation**: Improving or adding documentation |
| 40 | +- **Performance**: Optimizing CSS output |
| 41 | + |
| 42 | +### Workflow |
| 43 | + |
| 44 | +1. Create a new branch for your contribution: |
| 45 | + ``` |
| 46 | + git checkout -b feature/your-feature-name |
| 47 | + ``` |
| 48 | +2. Make your changes, following the [coding standards](#coding-standards) |
| 49 | +
|
| 50 | +3. Test your changes: |
| 51 | +
|
| 52 | + - Ensure styles render correctly across different browsers |
| 53 | + - Check that the CSS output is optimized |
| 54 | +
|
| 55 | +4. Commit your changes with descriptive commit messages |
| 56 | +
|
| 57 | +## Coding Standards |
| 58 | +
|
| 59 | +### Sass Guidelines |
| 60 | +
|
| 61 | +- Use variables defined in `_variables.scss` for colors, spacing, etc. |
| 62 | +- Maintain the classless approach - styles should target semantic HTML elements or aria attributes |
| 63 | +- Keep specificity as low as possible |
| 64 | +- Use mixins for repeatable patterns |
| 65 | +
|
| 66 | +### CSS Output Guidelines |
| 67 | +
|
| 68 | +- Keep the CSS output minimal and optimized |
| 69 | +- Avoid unnecessary nesting that creates complex selectors |
| 70 | +- Ensure compatibility with modern browsers |
| 71 | +
|
| 72 | +## Pull Request Process |
| 73 | +
|
| 74 | +1. Update the README.md or documentation with details of your changes if needed |
| 75 | +2. Make sure your code passes all tests |
| 76 | +3. Submit your pull request with a clear description of the changes |
| 77 | +4. Reference any related issues in your pull request |
| 78 | +
|
| 79 | +## Documentation |
| 80 | +
|
| 81 | +When adding new features or components: |
| 82 | +
|
| 83 | +1. Document how to use it in the appropriate section of the documentation |
| 84 | +2. Include examples of the HTML structure required |
| 85 | +3. Explain any customization options available |
| 86 | +
|
| 87 | +## Questions? |
| 88 | +
|
| 89 | +If you have any questions or need help, feel free to open an issue or reach out to the maintainers. |
| 90 | +
|
| 91 | +Thank you for contributing to launch.css! |
0 commit comments