Skip to content

Latest commit

 

History

History
59 lines (49 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

59 lines (49 loc) · 1.86 KB

Contributing to Tuisic

Thank you for considering contributing to Tuisic, a terminal-based music streaming tool. We value your feedback and contributions, whether it's a bug fix, feature enhancement, or documentation improvement. Here’s how you can get started:

How to Contribute

1. Report Issues

  • Check the issues to see if your bug/feature is already discussed.
  • If not, create a new issue. Include detailed steps to reproduce the bug or describe the feature.

2. Suggest Features

  • If you have ideas for new features, open a feature request issue.

3. Code Contributions

  • Fork the repository and clone it to your local machine.
  • Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  • Make your changes and test thoroughly.
  • Commit your changes with meaningful commit messages.
  • Push your branch: 
    git push origin feature/your-feature-name
  • Create a pull request from your fork to the main branch.

4. Documentation

  • Contributions to the documentation are highly appreciated. You can help by improving clarity, fixing typos, or adding usage examples.

Guidelines

  • Follow the code style of the project.
  • Write meaningful commit messages and comments.
  • Update the documentation if your changes affect usage.

Development Setup

  1. Clone the repository: 
    git clone https://github.com/Dark-Kernel/tuisic.git
cd tuisic
  2. Ensure dependencies like libmpv are installed.
  3. Build the project: 
    mkdir build && cd build
cmake ..
make
  4. Run the app: 
    ./tuisic

Communication

Feel free to reach out through:

Excited to see your contributions and help grow Tuisic!