ROADMAP.md for WordPress developers

On the [WPwatercooler](https://www.wpwatercooler.com/) podcast this week — while talking about [what's coming in 2020](https://www.wpwatercooler.com/video/ep349-looking-at-wordpress-in-2020/) — I proposed that WordPress plugin developers might want to consider adding `ROADMAP.md` files to their GitHub repos.

Much like `CHANGELOG.md` shows you where a project has been, `ROADMAP.md` would show you where a project is headed.

* Planning on fixing a long-standing issue? _Put it in `ROADMAP.md`._
* Working on a new feature? _Put it in `ROADMAP.md`._
* Getting ready to roll out indexes for common database queries? _Put it in `ROADMAP.md`_

Standard changelog rules apply. Group things by version number, with simple, digestible bullet points. Add context where necessary. Avoid putting dates on things so you're not on a deadline.

Unlike changelogs, which are kept in reverse-chronological order, roadmaps should be kept in chronological order. What's coming up in the next release should be the first thing people read. You don't want to make your users dig around for what's next, do you?

Should anyone decide to do this, I'd love to know about it. At me on [Mastodon](https://mastodon.social/@boogah/) or [Twitter](https://twitter.com/boogah) and send me a link to your repo!

tags: wordpress, roadmap, changelog

You are viewing proxied material from tilde.club. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.