diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 986f022..f2bbc6c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,30 +4,4 @@ Thank you for your interest in contributing to the frontend project. This guide ## Visual Studio Code Dev Container -This project contains a Visual Studio Code `.devcontainer` configuration folder. This [Dev Container](https://code.visualstudio.com/docs/remote/containers) will install Node.Js, pre-commit (and install the hooks), and run npm install for you, so the image is ready to go after building. It also installs HomeBrew. If you have GitHub Codespaces, just start one with this project, let it build, and you are ready with all the below requirements and can start coding. Same for using Docker on your local machine with Visual Studio Code's Docker Remote Extension. - -## Linting & Commit Hooks - -We use [pre-commit](https://pre-commit.com/) for our linting and quality control tooling, so it is required that you install the pre-commit hooks (normal and commit-msg stages) so that your PR meets our quality control standards. If you fail to do this, we have [pre-commit.ci](https://pre-commit.ci/) configured on all PRs, and it will flag up any errors there may be. - -There is also commitlint (which is included in our pre-commit config) in place, which is configured to use the [conventional commit](https://www.conventionalcommits.org/) standard. If your PR does not meet the specified standard, changes may be requested or your changes may be rejected. - -```bash -# After installing pre-commit... -$ pre-commit install -$ pre-commit install --hook-type commit-msg -``` - -## Merge Commits - -Merge commits must be styled as follows: - -``` -chore(merge): from_branch -> to_branch -``` - -For example, if you had merged `main` into `develop`: - -``` -chore(merge): main -> develop -``` +This project contains a Visual Studio Code `.devcontainer` configuration folder. This [Dev Container](https://code.visualstudio.com/docs/remote/containers) will install all the prerequisites and run npm install for you. diff --git a/README.md b/README.md index da15ce6..a443f83 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,9 @@ This is the front-end repository for Trunk-Player-NG. This project is still in d This current status of the frontend project. -### Main Branch - -[![Main Branch](https://github.com/Trunk-Player/Trunk-PlayerNG-Frontend/actions/workflows/node.js-push-main.yml/badge.svg?branch=main)](https://github.com/Trunk-Player/Trunk-PlayerNG-Frontend/actions/workflows/node.js-push-main.yml) - ### Develop Branch -[![Develop Branch](https://github.com/Trunk-Player/Trunk-PlayerNG-Frontend/actions/workflows/node.js-push-develop.yml/badge.svg?branch=develop)](https://github.com/Trunk-Player/Trunk-PlayerNG-Frontend/actions/workflows/node.js-push-develop.yml) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Trunk-Player/Trunk-PlayerNG-Frontend/develop.svg)](https://results.pre-commit.ci/latest/github/Trunk-Player/Trunk-PlayerNG-Frontend/develop) +[![Unit Tests and Linting](https://github.com/Trunk-Player/Trunk-PlayerNG-Frontend/actions/workflows/Validate.yml/badge.svg?branch=develop)](https://github.com/Trunk-Player/Trunk-PlayerNG-Frontend/actions/workflows/Validate.yml) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Trunk-Player/Trunk-PlayerNG-Frontend/develop.svg)](https://results.pre-commit.ci/latest/github/Trunk-Player/Trunk-PlayerNG-Frontend/develop) ## About Project Branches