vuejs / vuejs/docs

Enforce styling across the repo

Open
#233 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

workflow
Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

I'm noticing that we are having some different auto-formatting styles in some of the PRs. I'm thinking we should have an opinionated styling formatting for contributors going forward so we don't have large style changes going forward.

Proposal

This might be two pronged:

  • Include an opinionated .prettierrc file so people's autoformat follows the team's standard consistently
  • Add a pre-commit hook for linting and standardizing styles

What do you think @NataliaTepluhina @phanan @sdras?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking the repository's current contributor and formatting setup, then assess the proposed .prettierrc file and pre-commit hook. Done means contributors have a documented, consistent formatting standard and style checks run before commits without introducing broad unintended changes.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.