Comments (5)
I think the first thing we need to decide is whether we want to do this for the website only or also flag breaking changes in the package.
from simple-icons-website.
If we can build this into the website without adding it to the package, I see no reason why that decision should block this issue. But that's quite a big if. How did you implement this @PeterShaggyNoble ?
from simple-icons-website.
I currently have a pair of arrays hardcoded into my local build script that I manually update with each new breaking change. Thinking things through a bit, both options are going to create a little more work but I think adding them to the package might offer more benefits. If we add them to the website only then we have to:
- Create the PR in the main repo
- Add the breaking change to the website repo somehow
- Remove all the breaking changes from the website repo after the release
Whereas if we add it to the package, we only have to:
- Create a PR for the breaking change in the main repo
- Create a second PR in the main repo to add the flag to the JSON
with the first option, I can see us on occasion easily forgetting steps 2 & 3, as it's in a separate repo. Unless 3 can be somehow automated using the release action. Forgetting to remove derprecations wouldn't be a big issue but forgetting to remove renames could be, depending on implementation. And, on the rare occasions that its an outside contributor submitting a breaking change then they're definitely not going to realise they have to make changes in another repo, too.
With the second option, everything's done in the main repo in just 2 steps and has the added benefit of allowing us to expose the flags in the package which would allow us to log* warnings and errors alerting users of breaking changes.
*assuming Node has a console to log them too!
from simple-icons-website.
I'd definitely be against keeping a manually updated list in this repository for that. I was thinking it could be automated by looking at the icons/*.svg
files removed in Pull Requests belonging to the next major release. And in that case I don't see how this would be blocked by a decision in this regard on the package. I'm also not convinced it should be added to the package if it is just so we can display the information on the website.
from simple-icons-website.
Oh, if it could be automated against the activity in the main repo, that's be incredible. That would then we'd have time to discuss adding flags to the package separately without it blocking anything in the meantime.
from simple-icons-website.
Related Issues (20)
- Outdated Contributing file HOT 1
- Showing number of Search Results HOT 2
- Website design suggestions HOT 2
- "Sort by color" icon is confusing HOT 6
- Colored icon mode HOT 4
- Nokia icon update request
- Generate PDFs on client side
- Reactive translations
- Partial renderings to avoid performance problems HOT 4
- Grid and/or whole site mangling
- Refactor modal
- Redesign third party extensions table
- The "Sort by relevance" icon is confusing
- SSL
- relm.pro HOT 1
- Icon of copy hex inside details modals not following theme
- CDN crashed.. images no longer loading HOT 5
- Base64 JPEG HOT 1
- Proposal | to change the style and color of the page scroll
- Let users style the icons HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from simple-icons-website.