Skip to content

Latest commit

 

History

History
28 lines (15 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

28 lines (15 loc) · 1.86 KB

Contributing to the TASVideos Site

Welcome! The TASVideos staff have set up links here to help guide new developers toward contributing to the code behind the TASVideos website.

Directing Contributions

Please feel free to file issues for any bugs observed! The maintainers will aim to confirm and mark them with a milestone based on their severity. We also welcome creating PRs directly if the solution is readily available and a maintainer will review the pull request and merge it. Developers who submit more complex or frequent PRs are encouraged to join the site discord and ask for a site developer role. Any contributions will be licensed under GPL v3.

If a security issue is found please instead follow our security policy to disclose the issue.

Code of Conduct

Contributors are expected to uphold a basic code of conduct in all interactions inside and outside of the project.

Developer Setup

See Local Development Setup in the readme for instructions on running the site locally for development.

There are several test suites in the /tests directory, which you can run in the conventional way (dotnet test [TASVideos.sln]). They are also run in CI.

Code Style

The codebase uses the Allman style, placing braces on their own line. It uses tabs for indentation including in HTML in CSHTML where it acts as a single space when parsed by web browsers. Otherwise, code style should generally follow conventions for .NET 5 and C#.

Site Design

The site has a design document which details the structure, philosophy, and design goals of the frontend segments of the codebase which is great study for aspiring frontend contributors.