Comments (7)
What do you think of doing something like the following for less verbosity?
I don't think there's a way to make the summary interpret markdown on the first line
from ratatui.
It looks like we also get double headers for some reason. (v0.26.2 and then v0.26.2 2024-04-15)
I'm unable to reproduce this, can you show me an example?
A top section that just directly lists the commit message titles e.g.:
Yeah, it should be fairly simple to do that. Looks similar to the github
template example.
A couple of questions:
- Are you proposing the revamp the entire changelog format or just adding a summary?
- What's wrong with the current format? Yeah it's long but everything is there. I especially like the fact that we include the commit body. Maybe we can make it a collapsible content though, not sure.
from ratatui.
I'm unable to reproduce this, can you show me an example?
Details
https://github.com/ratatui-org/ratatui/releases/tag/v0.26.2
Compare: joshka/tui-scrollview#14
Are you proposing the revamp the entire changelog format or just adding a summary?
Change the format so that the important information is up top in the zone that doesn't get truncated by the tooling around releases.
What's wrong with the current format? Yeah it's long but everything is there. I especially like the fact that we include the commit body. Maybe we can make it a collapsible content though, not sure.
I'd like to see this in a format that works well with the ecosystem of tools that are in use. That includes dependabot, github releases, and the github home feed. Long is fine, but for the most part, tools truncate things the changelog / release notes, so it's important to include the right information up front:
from ratatui.
Okay I see what you mean. Regarding Dependabot duplicating the header, it might be happening due to multiple things. Maybe it's because we're missing v
, using ##
instead of #
or even including the link. I'm not sure how to fix that, but we can try to keep it simple by just including the version (similar to mio
) next time and hope that it doesn't duplicate it. It's lowkey brute forcing, but I really don't want to dig into some Ruby code to find it out. But I digged in anyways: https://github.com/dependabot/dependabot-core/blob/7b25e935cd0a1f9a89abf6ce865cea69090c298d/common/lib/dependabot/metadata_finders/base/changelog_finder.rb#L57
Do you think adding a summary section to the top of the changelog only from the "feature" commits is a good idea?
For example (assume they are all feature commits):
## Summary
* docs(github): update code owners about past maintainers
* fix(examples): changed user_input example to work with multi-byte unicode chars by @OkieOth in [#1069](https://github.com/ratatui-org/ratatui/pull/1069)
* fix(examples): fix key handling in constraints by @psobolik in [#1066](https://github.com/ratatui-org/ratatui/pull/1066)
* docs(github): update code owners by @orhun in [#1067](https://github.com/ratatui-org/ratatui/pull/1067)
But then we will be duplicating the entries in the changelog, hmm..
from ratatui.
I'm not too sure. Btw, this is very much one of those places which is about gold plating, but I've called it out as you own git cliff and gold plating here might help the wider git cliff perspective.
from ratatui.
What do you think of doing something like the following for less verbosity?
97ee102 (buffer) Track_caller for index_of by @EdJoPaTo in #1046
The caller put in the wrong x/y -> the caller is the cause.
from ratatui.
sorry for the false ping, I just wanted to share an example :D
from ratatui.
Related Issues (20)
- Support block titles in top-right and bottom-right HOT 4
- Onboard to bencher, to start tracking benchmarks over time HOT 9
- Reuse std::fmt::Alignment HOT 3
- Running `cargo test` fails HOT 6
- Inconsistent behavior between `Line::from` and `Line::raw` HOT 3
- Allow bypassing diff and writing all to screen HOT 6
- RSX-based interface to reduce boilerplate code HOT 5
- Make methods / fields on buffer that deal with the underlying content index private.
- Italic Borders? HOT 3
- `clippy::same_name_method` with Stylize HOT 3
- Add a Buffer::fill method
- Move away from using Prelude / glob imports
- Add .next()/.prev() to ListState to make traversing a list of selectable items easier HOT 4
- Consistent examples in ratatui HOT 2
- Add Stylize methods directly to Style HOT 3
- index out of bounds: the len is 17526 but the index is 17526 HOT 9
- Change examples folder structure HOT 4
- Features documentation on docs.rs isn't right. HOT 4
- TableState resets offset to 0 HOT 2
- Bug: ensure that block title rows apply the border style
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 ratatui.