Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (20 loc) · 742 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 742 Bytes
Raw

Contributing to react-sounds

Thanks for your interest in contributing!

Getting Started

  1. Fork and clone the repo
  2. Install dependencies: npm install
  3. Build the project: npm run build
  4. Run tests: npm test

Development

  • Source code is in src/
  • Sound manifest is at src/manifest.json
  • Website/docs are in website/

Pull Requests

  • Open an issue first for major changes
  • Keep PRs focused on a single change
  • Add tests for new features
  • Run npm run lint and npm test before submitting

Adding Sounds

Sound files go in sounds/<category>/. Run npm run build:sounds to regenerate the manifest.

License

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