CONTRIBUTING.md

# Contributing to Environmental Sound Dataset

<!--
Project: Environmental Sound Dataset
Website: https://rskworld.in
Founded by: Molla Samser
Designer & Tester: Rima Khatun
Email: help@rskworld.in
Phone: +91 93305 39277
-->

Thank you for your interest in contributing to the Environmental Sound Dataset project!

## How to Contribute

### Reporting Issues

If you find a bug or have a suggestion, please open an issue on the project repository with:
- A clear description of the issue
- Steps to reproduce (if applicable)
- Expected vs actual behavior

### Adding Audio Samples

To contribute audio samples:

1. Ensure audio files are in WAV, MP3, or FLAC format
2. Follow the dataset structure (see `DATASET_STRUCTURE.md`)
3. Organize files by class in appropriate train/test directories
4. Ensure audio quality is good and files are not corrupted

### Code Contributions

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Ensure code follows existing style and includes proper comments
5. Test your changes
6. Commit your changes (`git commit -m 'Add amazing feature'`)
7. Push to the branch (`git push origin feature/amazing-feature`)
8. Open a Pull Request

### Code Style

- Follow PEP 8 for Python code
- Include docstrings for all functions
- Add comments explaining complex logic
- Include your contact information in file headers (as shown in existing files)

## Contact

For questions about contributing:
- Website: https://rskworld.in
- Email: help@rskworld.in
- Phone: +91 93305 39277

---

**RSK World** - Free Programming Resources & Source Code
Founded by Molla Samser, with Designer & Tester Rima Khatun