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.

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

chore: create NEWS.md #48

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: create NEWS.md #48

wants to merge 2 commits into from

Conversation

moul
Copy link
Contributor

@moul moul commented Dec 3, 2023

Addresses #24 (comment).

I'd like your opinion on writing super long markdown lines to be more unix-friendly (grep, etc.) versus using the current method of having multiple lines in the raw files but preserving a single line in the generated markdown.

@moul moul added the meta label Dec 3, 2023
@jaekwon
Copy link
Contributor

jaekwon commented Dec 4, 2023

What's more grep friendly?
I don't expect everyone to split everything so it more or less fits in 80 chars.
But I will do it for you. And the resulting file is readable via vim or emacs.
I'm not sure what you're referring to otherwise.

@moul
Copy link
Contributor Author

moul commented Dec 4, 2023

The "grep-friendly" feature allows accepting very long lines to ensure the date is always visible. Another option is to have multiple lines per day, still keeping them grep-friendly within 80 characters.

I tested the other option and found it works better on emacs/vim, but not as well with markdown rendering, unless we avoid embedding links to issues.

I'm curious about the format you have in mind. Could you please share?

@jaekwon
Copy link
Contributor

jaekwon commented Dec 8, 2023

Is this news? #59

@moul
Copy link
Contributor Author

moul commented Dec 8, 2023

The question is more directed towards others. Personally, I connect daily and check the unread blue label.

There are two main strategies for news:

  1. Keep it simple and expect people to invest time and effort, avoiding laziness. This may result in fewer people but potentially higher quality.
  2. Provide simple news that can be used as a weekly report or automatic tweets, making it more accessible to a larger audience.

We can implement strategy 1 here and rely on the community to implement strategy 2 outside of the repository. This way, the repository can focus on building while external communication is managed separately.

The advantage of using 2, if implemented progressively like a changelog file, is that it makes it easy to check the git history/blame of the NEWS file. However, this competes with the already satisfactory feature of GitHub history.

I would appreciate additional opinions from more concerned individuals.

@moul
Copy link
Contributor Author

moul commented Dec 8, 2023

I'm glad to help with the news about fireside chat (#53), but someone with stronger English skills might be better suited. We can schedule a call every two weeks to share updates (with screen sharing). During the call, we can engage in an AMA, discuss topics, and delve into details with the participants.

I believe it has the best ratio of low effort to high impact. It will facilitate the community in sharing news on social networks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants