Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (46 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 1.33 KB

Contributing to SafeSound

Thanks for your interest in contributing! 🎉
Whether you're fixing bugs, improving docs, or adding new features — your help is appreciated.

🛠 Prerequisites

  • Follow the installation instructions in README.md

🚀 Getting Started

  1. Fork the repo
  2. Clone your fork: 
    git clone https://github.com/janksmap/safesound.git
cd safesound
  3. Create a branch for your changes: 
    git checkout -b my-feature

📐 Code Style

  • Use meaningful variable names and comments.
  • Write docstrings for all public functions and classes. (I know I don't have this yet, but I'm working toward it. Feel free to help if you can!)

✅ Testing

Before you open a pull request:

  1. Test your changes with: 
    python3 safe_sound.py test_audio.mp3
  2. Make sure the script runs end-to-end
  3. No debug prints or commented-out code

📄 Submitting a Pull Request

When ready:

  1. Commit your changes: 
    git commit -m "Add feature: X"
  2. Push your branch: 
    git push origin my-feature
  3. Open a pull request on GitHub with a clear description of your changes.

🙌 Thank You!

You're helping make SafeSound better for everyone. We appreciate every contribution, large or small!