Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (38 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 1.25 KB

Contributing to Scape.js

Thanks for your interest in contributing.

How to Contribute

  1. Fork the repository.
  2. Create a branch from main.
  3. Make focused changes.
  4. Test your changes locally.
  5. Open a pull request.

Development Setup

  1. Clone your fork.
  2. Open the project folder.
  3. Run the demo by opening index.html and demo/index.html in a browser.
  4. Make your changes in scape.js, docs, or demo files.

Coding Guidelines

  • Keep the library lightweight and dependency-free.
  • Preserve public API compatibility unless the change is intentional.
  • Use clear variable names and minimal comments.
  • Avoid unrelated formatting changes.

Pull Request Guidelines

Please include:

  • A short summary of what changed.
  • Why the change is needed.
  • Any breaking changes.
  • Before/after behavior (screenshots or GIFs for UI/demo changes if possible).

Commit Guidelines

Use clear commit messages, for example:

  • fix: correct shape rendering on resize
  • docs: add API usage examples
  • feat: add new shape type

Reporting Issues

When opening an issue, include:

  • Browser and version
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Console errors (if any)

Code of Conduct

Be respectful and constructive in all interactions.