Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.44 KB

File metadata and controls

40 lines (25 loc) · 1.44 KB

Contributing to StreamSpeak

First off, thank you for considering contributing to StreamSpeak! It's people like you that make open source software such a great community.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue and describe the enhancement you have in mind.
  • Please be specific and provide as much detail as possible.

Pull Requests

  • Fork the repo and create your branch from main.
  • Ensure the test suite passes.
  • Make sure your code lints.
  • Issue that pull request!

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.

Code Style

  • Follow the existing code style.
  • Keep it simple and readable.

Any other questions?

Feel free to reach out to the maintainer, ramo-dev, on GitHub.