Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (50 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

85 lines (50 loc) · 1.88 KB
Raw

Contributing to KeyframeCSS

Thank you for considering contributing to KeyframeCSS. This document describes the rules and workflow for contributing to this project.

Project Overview

KeyframeCSS is a lightweight CSS animation library that allows applying animations via utility-like classes (e.g. anim kf-bounce).

Contribution Workflow

This project uses the Fork & Pull Request workflow:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your modifications
  4. Submit a Pull Request to the main repository

All contributions must go through a Pull Request.

Pull Request Requirements

  • Keep changes focused and minimal
  • One feature or fix per PR
  • Provide a clear description of what was changed
  • Reference related issues if applicable

Code Style

No strict tooling is enforced.

However, all contributions must follow these rules:

  • Keep CSS readable and consistent
  • Use clear and descriptive class/keyframe names
  • Avoid unnecessary complexity
  • Maintain consistent indentation

Commit Messages

Please use clear and descriptive commit messages.

Recommended format:

feat: add bounce animation
fix: correct keyframe timing
docs: update usage examples

or

Added horizontal line movement to kf-bounce animation

This is not strictly enforced but strongly recommended.

Pull Request Review

All Pull Requests must be reviewed before merging.

A PR will only be merged if:

  • It is reviewed and approved
  • It does not break existing animations
  • It keeps the library lightweight and consistent

Issues

Before opening an issue:

  • Check if the issue already exists
  • Use the provided issue templates

Code of Conduct

Please follow the Code of Conduct to ensure a respectful and constructive environment for all contributors.

License

By contributing, you agree that your contributions will be licensed under the same license as this project.