Comments (3)
Hi @misitebao, I totally agree with the examples. I can see that this is an issue with slower internet. If you want to work on that, the README is modified in our CI-System (/ci
) (it's an awful messy piece of code, but "it works", so I would understand if you don't want to touch it).
For moving the *.go
files, I will keep this issue open for discussion. As you are already aware, I wanted to do this with #471, but decided not to, because of the breaking change. Yes, we currently are in v0
to be able to make breaking changes, without releasing a v2
, but I still think we should consider that this change will break ~1000 open-source projects and many more private repos. Although it would be an easy fix for the repo maintainers, as a simple replace all
in the project would do the job.
I think we should at least wait until the new GitHub design is public, which hides the file tree to a sidebar and puts the README at the top. We have a few breaking changes in the queue, until then we would still have time to evaluate that, as we want to have all breaking changes in one version (v0.13.0
)
from pterm.
If we move the *.go
files, we should probably include a single code block at the top of the README with a bash command to fix the import statements (for a couple of weeks), as a migration guide.
from pterm.
Hi @MarvinJWendt,
There are mainly two questions here:
- Update README and examlpes, including the corresponding CI program
- Migrate
.go
files in the root directory
For the first question, as you said, it will be more complicated. I think we can do it step by step, first manually update the README, and then update the others, because the README is the main factor affecting the speed of the home page. For examples and ci, it can be improved slowly.
For the second question, migrating .go
files is a major change and should be resolved in the next major version. However, because it is still in the 0.x.x
stage, compatibility can be ignored as long as users do not actively update dependencies. There will be no problem. But the user's CI system will automatically update dependencies according to the semantic version, so the best way is to release 1.0.0
or 1.0.0-beta
.
I know about the new design of GitHub you mentioned, and I have experienced it for a day, but I donβt think it has much to do with the project, because it should be platform-independent. Also I personally think it would be confusing to have the code file with other bits and pieces in the root of the project.
The above is just my personal suggestion and I'd be happy to push it forward.π
from pterm.
Related Issues (20)
- Add `reviewdog` with `golangci-lint`
- Add support for linux 'watch' command HOT 2
- wrong print of box with title including asian characters HOT 1
- Migrate to classic `golangci-lint` action
- Library check and uncheck all of duplicated option names HOT 1
- Request to add a timeout for InteractiveConfirm HOT 2
- Proposal: Add handler for log/slog
- `BasicTextInput` weird
- Fix `interactive_multiselect` examples
- Stopped spinner over writes the progressbar HOT 4
- Repeating Prompt Text when Default Text Goes Beyond Single Line
- Make `spinner.Stop` return itself
- Pasting in a string that is 1043 characters during interactive text input causes repeats in prompt HOT 8
- Importing pterm causes program to not exit on SIGINT and SIGTERM HOT 7
- Multi-select components support horizontal display
- Default Value for InteractiveTextInput HOT 2
- Request to add callback for area_printer.Update HOT 2
- Improve linting config
- heatmap demo not working properly
- mutli-live-printers + spinner update text not working HOT 2
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 pterm.