Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

72 lines (45 loc) · 2.91 KB
SoundSage Logo

Contributing to SoundSage---LLM-Audio-Processing-Integration

First off, thank you for considering contributing to SoundSage---LLM-Audio-Processing-Integration. It's people like you that make SoundSage such a great tool.

How Can I Contribute?

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the project! Everyone is welcome to contribute, regardless of their level of expertise. See the To Do List for information regarding where we are at!

Here's how you can make a difference:

Reporting Bugs

This section guides you through submitting a bug report for SoundSage. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for SoundSage, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and make decisions.

Your First Code Contribution

Unsure where to begin contributing to SoundSage? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

The process described here has several goals:

  • Maintain SoundSage's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible SoundSage
  • Enable a sustainable system for SoundSage's maintainers to review contributions

Styleguides

Git Commit Messages

  • 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 liberally after the first line

Python Styleguide

All Python must adhere to the PEP 8 style guide.

Code of Conduct

This project and everyone participating in it is governed by the SoundSage Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]]

Thank You!

Again, thank you for your contributions. You make SoundSage awesome, and we're grateful that you're helping us make it even better.

SoundSage Logo