Skip to content

increasinglyHuman/JazzyPop

Repository files navigation

Contributing to JazzyPop

We love your input! We want to make contributing to JazzyPop as easy and transparent as possible.

Development Process

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. Ensure the test suite passes
  4. Make sure your code follows the existing style
  5. Issue that pull request!

Code Style

  • JavaScript: ES6+, async/await preferred
  • CSS: Mobile-first, BEM-like naming for components
  • No external UI frameworks: Keep it vanilla for ALM compatibility
  • Accessibility: WCAG 2.1 AA compliance

Design Guidelines

  • Emojis: Use sparingly and meaningfully
  • Typography: Large, readable fonts (min 16px)
  • Touch targets: Minimum 44x44px

Commit Messages

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

Testing

Run tests with:

npm test

Reporting Bugs

Use GitHub Issues. Include:

  • Browser version
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable

License

By contributing, you agree that your contributions will be licensed under the MIT License.

About

A funky pop quiz machine

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors