Thank you for taking the time to contribute! Here are a few things to help you:
Package names tend to fall under the following convention:
audio-*
: Packages related toaudio
,audio-buffer
,audio-oscillator
etc. Typically implement functional interface: a constructor, returning a function. Usually utiliseaudio-format
to solve common problems related to audio data conversions.audio-*-stream
: Packages with nodestream
interface, usually wrappers over plainaudio-*
packages, enabling audio processing.pull-audio-*
: Packages with pull-stream interface, usually wrappers over plainaudio-*
packages, enabling audio processing.web-audio-*
: Packages related to the Web Audio API.audio-*-native
: Node addon implementation of audio processing module.audio-*-wasm
,audio-*-asm
: WebAssembly implementation of a package.
- Please verify new stream components with streams convention.
- Audiojs uses very loose code style .eslintrc.json, please verify code with at least this rule set, or if you prefer, with stricter versions like standard etc.
- Fork or branch from the master.
- Create commits following the commit style
- Start a pull request to the master branch
- Wait for a @audiojs/core member to review
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests
(From electron's commit style)
- audio-lab: Sound research tools
- stability-badges: The badges used here to show stability.