Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

88 lines (58 loc) · 2.3 KB

Contributing to switchtube-dl

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Run Locally

Prerequisites
  • .net6 SDK needs to be installed
Steps

Clone the repository

git clone [email protected]:panmona/switchtube-dl.git

Go to the project directory

cd switchtube-dl

Install the necessary tools

dotnet tool restore

Test the CLI

cd src/SwitchTubeDl
dotnet run -- {your args}

Run tests

cd src/Tests
dotnet run

Did you find a bug?

  • 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 and as much relevant information as possible demonstrating the expected behavior that is not occurring.

  • Use the bug report template to create the issue.

Did you write a patch that fixes a bug?

If you've gone the extra mile and have a patch that fixes the issue, you should submit a Pull Request!

  • Please follow our Coding Conventions
  • Fork the repo on Github.
  • Create a feature branch from where you want to base your work.
  • Use "fix", "add", "change" instead of "fixed", "added", "changed" in your commit messages.
  • The first letter in your commit message should be upper-case
  • Push to your fork and submit a pull request.
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in an issue before you start writing code.

Coding Conventions

All source code is formatted according to the Styleguide, with the exception of us using the Stroustroup Style. You can format it that way by using this command:

dotnet fantomas src -r

Ensure that the fantomas tool is up to date:

dotnet tool restore
  • All modules should have the [] attribute
  • All DUs should have the [] attribute. An exception to this rule are single case DUs with a value.