HNHacker News
TopNewBestAskShowJobs

olivierlacan

891 karma · joined March 4, 2014

Software bricoleur https://olivierlacan.com

Maintained Code School 2012-2018.

Created https://shields.io

Maintainer of https://keepachangelog.com

Tending to https://indigene.app

submissionscomments
olivierlacan··on Hyperloop – The Missing Ruby Front-end Library
I think you mean the Ruby community excels at memorable and often witty naming for libraries that makes searching for documentation, blog posts, and other references extremely easy because "ruby <very unique name>" doesn't ever return more than a few irrelevant results.

That must be what you mean.

olivierlacan··on Atmospheric carbon dioxide passes 400ppm
Worth reposting: What can a technologist do about climate change? http://worrydream.com/ClimateChange/ (2015)
olivierlacan··on Ruby Deoptimization Engine
Check out https://rubybench.org/benchmarks for Rails, Ruby, and Bundler benchmarks on every commit and release to either project.

If you want Rails-specific benchmarks for Ruby commits I suggest the `discourse_` benchmarks that are running specific chunks of the open-source Discourse Rails app: https://rubybench.org/ruby/ruby/commits?result_type=discours...

olivierlacan··on Keep a Changelog
git commit's -v or --verbose flag allows you to see a diff of your currently staged changes so that sounds somewhat similar to your command.

I find that seeing the exact changes you're about to commit does lead to more detailed git commit messages, although the maximum length of most "properly" written commit message titles (50 characters) tends to hinder the quality of commit message titles as entries in a changelog. They're often very high level summaries of introduced changes and it's common for people to focus on the change at hand — not on its impact on end-users — when writing a commit.

Again, this all goes back to the intended audience for commit messages compared to change logs. If the end users of the projects you work on diligently read every commit in the project history, then I dare suggest you're in a rare and privileged situation. I don't expect end-users of most open source software to be satisfied with either the high-level nature of commit titles, or their minutia. This leads me to think that keepachangelog.com needs to gather more examples of the of changelogs I advocate for. It seems that a surprisingly small number of people have encountered them.

Rebasing and squashing commits to clean them up to be changelog-worthy does not solve the 50-character issue with conventional commit titles I mentioned above. It also doesn't solve for situations with collaborative pull requests or branches. That is, unless there's a clear process for squashing and rebasing being done by a single person at the very end of the project. I think it's more realistic to expect a single file changelog to be regularly updated (through an Unrealeased section) as changesets are being introduced prior to a release and to eventually update this same single file when the group of changesets is about to be released under a new dated version release.

olivierlacan··on Keep a Changelog
Yeah, this is definitely not what I'm advocating. That sounds insane to me. Several contributors have pointed out that these conventions can be useful beyond the realm of open source so I think we've tried to make it a bit more general. It is definitely based on open source conventions though.

An open source project like Rails has different components all developed within a single repository although they're packaged up independently for release. Each different component has a root level changelog that documents its changes and there isn't a centralized changelog for all of Rails. In some ways it's problematic because you can't see a merged changelog for all core components of Rails but it's also useful when you're only worried about changes to the ORM component since you'll only see changes pertaining to it within its own changelog.

In my mind a changelog is a root-level concern for a single piece of software, regardless of how many isolated components it's composed of. Basic tooling should be able to centralize each changelog (as long as versions are synchronized, but that's another issue) and ideally you should be able to filter by sub-component.

This is definitely not something we've created any guidelines for yet. So if you have any thoughts on the matter, feel free to suggest them: https://github.com/olivierlacan/keep-a-changelog/issues

olivierlacan··on Keep a Changelog
I agree. Maintaining a changelog can be certainly be more difficult in large projects (although I don't think it has to be). I do think changelogs are a manifestation of the maintainers' care with regard to end-users. It signifies that they don't simply focus on the quality of the project itself but also how the project's evolution is perceived and understood by end-users and fellow contributors.

It's strange to me that anyone would consider especially open source software as something so good and obviously beneficial that the archeology you mention would be a fact of life for end-users. It betrays a misconception about the value of software in a vacuum: without tests, code documentation, interface design, and change documentation (a changelog).

The best algorithm is useless without proper tests verifying how it functions against real input; it's obscure without good documentation highlighting its quirks and design decisions, and if it evolves without clear explanations within a changelog then the changes in its behavior will remain mysteries to end-users as long as they don't go deep inside the code to understand how it worked before and how it works now.

I've had to do this kind of programmer-archeology on numerous production dependencies (transitive or otherwise) in the past and the resulting frustration is very much the fuel that motivated me to make keepachangelog.com

olivierlacan··on Keep a Changelog
I'm aware of hundreds if not thousands of projects on GitHub alone using similar ways of documenting changes with CHANGELOG-like files and regardless of their size/popularity I'm not aware of the issues you both seem to be worried about.

Generally people edit changelogs after pull requests have been merged or as part of the pull requests themselves. It's far easier to figure out merge conflicts if and when other versions appended to the changelog simultaneously because all changelog entries are dated (or at least they should be) or at least versioned and contain plain text.

That said I agree that we should probably spend some time detailing common processes for editing and appending to a changelog in situations with concurrent branches being developed.

olivierlacan··on Keep a Changelog
People have mentioned Org-mode repeatedly throughout the years since I first wrote down the thoughts that became keepachangelog.com but I'll be honest, Org-mode doesn't seem to be broadly used in the greater open source community whereas Markdown (or just plain text) CHANGELOG.md, NEWS.md, History.md, and others are far more common.

There's surely personal bias at play, but I'm far more concerned with people keeping a changelog in the first place to worry too much about how exactly they do it. If Org-mode is what they go with, fine, but what we're facing right now is hordes of open source projects that people end up taking on as direct or transitive dependencies and which do not document their evolution in any meaningful way.

olivierlacan··on Keep a Changelog
Sure thing, but it's evolved quite a bit since then. We've introduced a versioning system a few weeks ago, and we now have 8 translations other than English thanks to contributors, so I'd wager it's newsworthy. :-)

I've covered these recent changes in a post that didn't quite make it to the front page recently: http://olivierlacan.com/posts/logging-changes-all-over-the-w...

olivierlacan··on Keep a Changelog
A common convention we showcase in the Keep a Changelog changelog itself (https://github.com/olivierlacan/keep-a-changelog/blob/604e38...) is to have an [Unreleased] section at the top of the changelog. It rarely conflicts with other branches of a project because it only becomes a version prior to or after a merge into the main branch (trunk/master/etc.).

I'd agree this is an area we need to clarify for version 0.4.0 and forward.

olivierlacan··on David Chang’s Unified Theory of Deliciousness
You might want to watch this: https://www.youtube.com/watch?v=k1oR0EYaOHY

It's relevant because it's from Mind of Chef season 1 with David Chang.

olivierlacan··on French National Assembly approved Internet traffic monitoring system (French)
Yep, it's called anomaly hunting: http://theness.com/neurologicablog/index.php/anomaly-hunting...

It's very bad.

olivierlacan··on French National Assembly approved Internet traffic monitoring system (French)
La Quadrature du Net (French EFF equivalent) posted a campaign website with a rundown of which députés (congresspeople) are in favor or against the bill: https://sous-surveillance.fr

Also had VOIP phone to contact députés. Many were and avoided questions or said they would toe the party line. Evidence here: https://pad.lqdn.fr/p/PJLdeputes

olivierlacan··on Can they see my dick pic?
Do you mind helping out? https://github.com/olivierlacan/can-they-see-my-dick/issues
olivierlacan··on Can they see my dick pic?
Good idea, saved it for later in the rush to transcribe.
olivierlacan··on Can they see my dick pic?
Good idea, pull requests accepted: https://github.com/olivierlacan/can-they-see-my-dick/pulls

No being a jerk, seriously I'd love help with the copy. :-)

olivierlacan··on Can they see my dick pic?
The call to action (albeit now super prominent) has been there all day: https://github.com/olivierlacan/can-they-see-my-dick/commit/...

I'll try to make it... pop out more?

I'm so sorry.

olivierlacan··on Last Week Tonight with John Oliver: Government Surveillance [ft. Edward Snowden]
I transcribed the important part of the interview and put it up here with links to relevant info about each of the Patriot Act sections and NSA programs mentioned: http://cantheyseemydick.com
olivierlacan··on Keep a Changelog
Before you run to educate me about GNU's change log style guide, please go read this: https://github.com/olivierlacan/keep-a-changelog/commit/3039...

Thank you :-)

olivierlacan··on Keep a Changelog
I am. Based on the current status of change logs in many open source projects ((absence, poor quality, irregular updates), I believe these conventions can be improved upon and clarified. At the very least they can be explained better than a two line text file with not a single example.

The GNU conventions for change logs and news files are not exactly self-explanatory (semantics matter), which probably explains how rarely they have been followed to the letter. I have no data to back this up, but I doubt people who use and depend on open source software would discard this claim.

Now it's interesting to see this initiative mocked as a "not invented here syndrome" (Moru's comment). I did not define these guidelines, I merely gathered them from existing open source projects which were exceptionally good at communicating changes. The poor examples and the frustration that fueled this project came from projects that did the opposite:

- inconsistent (file naming, change categories, etc.)

- dumping git diffs which provides absolutely no value to end-users (OSS software users who need to regularly update their dependencies)

- littered with references to irrelevant issue trackers (which did not provide clarifications regarding the changes)

- poorly written with the wrong audience in mind (fellow project collaborators who have context vs. external users who don't)

- not given any dates or given confusing regionally-flavored dates

- and the crux of my frustration: not singling out and emphasizing API breaking changes and deprecations

Anyway, please don't dismiss this project because a convention exist in one community. This convention is not being followed for now and I would really appreciate your help in improving the status quo: https://github.com/olivierlacan/keep-a-changelog/issues

Thanks.

olivierlacan··on David Foster Wallace's Kenyon Commencement Speech (2005)
A beautiful video was made from this speech by The Glossary, it's available here: https://vimeo.com/68855377

The story behind it is here: http://www.adweek.com/adfreak/story-behind-water-inspiring-v...

olivierlacan··on Try Git
I confess: pro-cat propaganda was sneakily inserted in Try Git.
olivierlacan··on Try Git
Thanks so much for sharing this. I wrote Try Git with a lot of help from my co-workers at Code School and Matthew McCullough from GitHub. Knowing it impacted just one person the way it impacted you makes me incredibly happy.
olivierlacan··on Try Git
Because it doesn't put you in the right mindset.

A commit message should be formatted like an email to your past self, or your future collaborators. It should have a very descriptive and concise title (the first line of the message) written in the present tense and after a line break you should (when necessary) write an email style explanation of the reasoning behind the commit.

If you fixed something, is there context that should be useful for someone discovering this commit in a vacuum. Are there any related commits? If you added something, why? There is so much useful information that can be encoded in a commit message and discovered when someone does a `git blame` for example.

Caleb Thompson wrote a nice concise post on this: http://robots.thoughtbot.com/5-useful-tips-for-a-better-comm...

olivierlacan··on Try Git
The current version of Try Git isn't open-sourced. You can contact us (Code School) directly to report any issues: http://www.codeschool.com/support

1) That's true. Although sending beginners into a less/vi commit interface that is even more bewildering than the basic shell is not a good way to concisely introduce people to a new tool. The hardest part of teaching is what you chose not to teach. 2) We purposefully used the GUI file browser (My Octocat Repository) at the bottom to avoid having to systematically do `git status` in order to check the state of the repo.

olivierlacan··on Learning “computer code” will be offered in French primary schools
I learned basic electric circuitry in primary school in basically the same context (extra-curricular activity the hour after regular classes end, once a week) and it was great.

We learned how to solder stuff on circuit boards (yes, soldering irons, yes some kids burned themselves, big whoop), how to use glue guns (again, I burned myself a bit, nothing serious) to put components together when assembling basic machines.

Can you even imagine the kind of amazing physical computing kids could be doing with Arduino and Raspberry Pi these days. HTML & CSS seem like a no brainer. I learned those in a "Technology" (in regular class hours) during my last year of middle school (again, in Paris).

If it weren't for a sympathetic instructor who told us to do make a website using FrontPage on anything we were passionate about (RTS for me at the time) I'm not sure I'd be a web developer today. I think these kinds of a programs are a great first steps to get kids excited about the web and/or basic languages before middle school and high school classes (in our out of class schedule) provide more thorough or complex introductions to programming proper.

olivierlacan··on The Hitchhiker’s Guide to Python
Most of the guide was written two years ago: https://github.com/kennethreitz/python-guide
olivierlacan··on Learn Git in the Browser
After some consideration and re-reading the copy, you folks are right that people could be confused into thinking the word "octobox" is somehow a git concept or something important. I rephrased all the instances where we mention it in order to highlight the fact that we "decided" to name our directory that way. I think it should prevent confusion from now on.

Thanks a lot for the feedback. :-)

olivierlacan··on Learn Git in the Browser
It would be hard because it doesn't mean anything, it's just a name. I don't know, seems natural that one of our support docs about Try Git is the first result on Google for me. :-)
olivierlacan··on Learn Git in the Browser
An update to the advice is going up that will show `git add -A .` instead of `git add .` and explain:

> You can also type `git add -A .` where the dot stands for the current directory, so everything in and beneath it is added. The `-A` ensures even file deletions are included.

← PreviousPage 5 of 6Next →