First off, thank you for considering contributing to this project! It's people like you that make the open-source community such an amazing place to learn, inspire, and create.
Help us maintain a positive and inclusive environment:
- Be respectful and professional.
- Focus on what is best for the community.
- Gracefully accept constructive criticism.
- Use a clear and descriptive title for the issue.
- Describe the exact steps which reproduce the problem.
- Include details about your browser, OS, and hardware (microphone model).
- Explain why this enhancement would be useful.
- Provide a step-by-step description of the suggested enhancement.
- Mention any alternative solutions you've considered.
- Fork the repository and create your branch from
main. - Follow existing code styles (Standard Python and Google Style for JS).
- Write descriptive commit messages.
- Ensure the app runs using
setup_and_run.batbefore submitting.
When contributing to the UI/UX:
- Aesthetics First: Use modern, clean components.
- Glassmorphism: When adding new cards or panels, use subtle transparencies and blurs.
- Micro-interactions: Add hover effects and smooth transitions for all interactive elements.
- Consistency: Stick to the defined CSS variables in
style.css.
- Python: Flask 2.0+, Pydub for audio.
- JavaScript: ES6+, minimize external dependencies.
- Documentation: Update the
README.mdorARCHITECTURE.mdif you introduce new system logic.
Happy Coding! 🚀