Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename palette.styl #2108

Open
billyyyyy3320 opened this issue Jan 4, 2020 · 7 comments
Open

Rename palette.styl #2108

billyyyyy3320 opened this issue Jan 4, 2020 · 7 comments
Assignees
@billyyyyy3320
Labels
complexity: easy Easy complexity contribution welcome Contributions welcome good first issue Good for newcomers type: feature request Request to add a new feature version: 2.x

Comments

@billyyyyy3320
Copy link
Collaborator

billyyyyy3320 commented Jan 4, 2020 •
edited
Loading

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.
@billyyyyy3320 billyyyyy3320 added the complexity: easy Easy complexity label Jan 4, 2020
@billyyyyy3320 billyyyyy3320 self-assigned this Jan 4, 2020
@billyyyyy3320 billyyyyy3320 added the type: feature request Request to add a new feature label Jan 4, 2020
@kefranabg kefranabg added contribution welcome Contributions welcome good first issue Good for newcomers labels Jan 6, 2020
@meteorlxy
Copy link
Member

Breaking change

@meteorlxy
Copy link
Member

meteorlxy commented Jan 6, 2020 •
edited
Loading

To avoid a major version release, we can keep the palette.styl and display a deprecation notice if palette.styl exists, and totally remove it in next major version.

@billyyyyy3320
Copy link
Collaborator Author

Sounds good.👌

@bencodezen bencodezen added status: core team review Priority issues for the core team to review and removed status: core team review Priority issues for the core team to review labels Jan 31, 2020
@Mister-Hope
Copy link
Contributor

Mister-Hope commented Apr 14, 2020 •
edited
Loading

To avoid a major version release, we can keep the palette.styl and display a deprecation notice if palette.styl exists, and totally remove it in next major version.

Yes, we can support both while giving a warning in the console screen. So when can we have this feature?

@billyyyyy3320
Copy link
Collaborator Author

@Mister-Hope I'm a bit busy these days. If you'd like to take it, go ahead ~

@Mister-Hope
Copy link
Contributor

Mister-Hope commented Apr 14, 2020 •
edited
Loading

@Mister-Hope I'm a bit busy these days. If you'd like to take it, go ahead ~

But a rfc here, what shall we rename it? variables? I agreed with this one, but a shorter file name cound be better. Any ideas with a shorter one?

@JoaquinDecima
Copy link

I generate #2943 to fix this issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@billyyyyy3320 billyyyyy3320

Labels
complexity: easy Easy complexity contribution welcome Contributions welcome good first issue Good for newcomers type: feature request Request to add a new feature version: 2.x
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@bencodezen @kefranabg @JoaquinDecima @meteorlxy @Mister-Hope @billyyyyy3320