vuejs/vuepress

Rename palette.styl

Open

#2108 opened on Jan 4, 2020

View on GitHub
 (7 comments) (2 reactions) (1 assignee)JavaScript (22,300 stars) (4,782 forks)batch import
complexity: easycontribution welcomegood first issuetype: feature requestversion: 2.x

Description

Feature request

palette.style should be renamed since it's not only relevant to colors.

See config.styl.

What problem does this feature solve?

The name may confuse developers. See #2086.

What does the proposed API look like?

rename palette.styl to variables.styl or something else.

How should this be implemented in your opinion?

Rename it and update documentation. Add deprecated badge to palette.styl since it'll be a breaking change.

Are you willing to work on this yourself?

Yes.

Contributor guide

Tech stack
vuecss
Domain
frontenddocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic VuePress knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
72
Research direction
First, locate the palette.styl file in the repository and identify all references to it across the codebase, including imports and documentation. Then, review the existing config.styl as a model for the rename. Finally, update the documentation and add a deprecation notice to the old file. See issue #2086 for additional context on the naming confusion.