input-output-hk / input-output-hk/Developer-Experience-working-group

Channels for communicating major deprecation in cardano ecosystem libraries.

Open
#36 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
24
Forks
14
PR merge metrics
No merged PRs in 30d

Description

When Michael Peyton Jones attended the Working group meeting on Nov 1 to discuss future GHC support, the question was brought about communicating deprecations to users. Currently the IOG ecosystem (and the broader ecosystem as a whole) does not have a consistent system for communicating deprecations to developers either ahead of time or upon release.

After some high level research at options, I've arrived at the following suggestions
1. Github releases for deprecations in the CURRENT commit (as MPJ suggested, they can be followed via RSS feeds)
2. Pre-emptively creating a github issue to disclose the deprecation (and as a resource that can be linked directly from the below options)
3. keep a section in the readme on upcoming major changes (with a link to the pre-emptive issue)
4. `DEPRECATED` Pragmas (in the case of GHC support, this can be combined with CPP)

This would allow developers to be notified of the deprecation when looking through issues, at build time, or when investigating the repo directly, which is MUCH better than nothing, and i think all that could be asked.

I'd like to discuss this a bit more at the next Developer experience meeting, but this seems sound and reasonable to me.

Contributor guide

No contributing guide indexed for this repository

Research direction

No files or tests are named. Start by reviewing the four proposed communication channels and bring the question to the next Developer experience meeting; the work is done only when the project agrees on a consistent deprecation process.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, haskell
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.