Contributing

Workflow

1. 1
   Fork the repo

   Fork https://github.com/ECHO-Lit/ECHO-LIT.

2. 2
   Branch from main

   Use a prefix that describes the change: feature/, bugfix/, docs/, or refactor/.

3. 3
   Make your change and test it

   Frontend tests run on Vitest, backend tests run on pytest.

4. 4
   Open a PR against main

   Reference the issue you're closing with Fixes #n in the description.

Style

• Frontend: ESLint.
• Backend: PEP 8, checked with flake8 and formatted with black.

Code of Conduct

Contributions are governed by a Contributor Covenant 2.0 Code of Conduct, with a four-step enforcement ladder (correction, warning, temporary ban, permanent ban). Report conduct issues to janithmahanama47@gmail.com.

Credits

AudioLens is built by:

• Januda Lelwala
• Janith Mahanama
• Hesandi Mallawarachchi

AudioLens is built on and extends ECHO, an MIT-licensed audio interpretability tool created by:

• Anas Hussaindeen
• Chandupa Ambepitiya
• Dewmike Amarasinghe

Both ECHO and AudioLens are inspired by Google PAIR's LIT (Learning Interpretability Tool).