gitmoji icon indicating copy to clipboard operation
gitmoji copied to clipboard

๐Ÿ”™ for Backwards compatibility

Open shankari opened this issue 2 years ago โ€ข 8 comments

Emoji symbol

๐Ÿ”™

Emoji code

:back:

Emoji description

Code that adds backwards compatibility

Describe the use case of your emoji

Code that is used for backwards compatibility/live migration of online systems.

  • e.g. if the data format was originally {"foo": "bar"} but we want to change it to {"foo1": "bar"} so we write temporary code of the type
if "foo" in object:
    object["foo1"] = "bar"
    del object["foo"]

Is this use case covered by an existing emoji?

No โŒ

Does this emoji fall into the "how" or the "what" category?

  • [X] This proposal do not describe "how" a commit was made, but does in fact describe "what" is the contents of the commit about.

Examples

https://github.com/e-mission/e-mission-server/commit/3fc3762641642ebcf200c8d83ea6b770c5cb738e https://github.com/e-mission/e-mission-server/commit/1c3f128717c6b8374585eacc9dbf417bda5235b9 https://github.com/e-mission/e-mission-phone/commit/72db83c4c57e9d8f51b0d9a1556a86cf381415aa

Validations

shankari avatar Apr 24 '23 04:04 shankari

I am open to other emoji suggestions; I just think that backwards compatibility is a category of changes that should be captured.

shankari avatar Apr 24 '23 04:04 shankari

How about ๐Ÿ”„ (arrows_counterclockwise) ? The left arrow alone gives the impression quite similar to undo.

When we talk about backward compatibility, we think like:

  • old file can run in the new system
  • new system supports the old file

So ๐Ÿ”„ seems more clear to me.

Thanyanit-J avatar Jul 10 '23 04:07 Thanyanit-J

IMHO, backwards compatibility (bwc) should be included in the original commit that added the new syntax, but I can kinda see why one would want to have this if something was forgotten (but in this case I would use :bug: because if the application needed to have bwc and we didn't add it before, it is a bug to me), or maybe even explicitly separate it to git revert it later...

Anyway, since the back arrow really does remind of the :rewind: emoji, what do you people think of using :t-rex: or :sauropod: (cuz it's a extinct API, get it? funny)

vhoyer avatar Jul 14 '23 19:07 vhoyer

Didnโ€™t see the dinosaur coming lol. Those are really good.

โ€œ๐Ÿฆ– Ensuring feature backward compatibilityโ€œ โ€œ๐Ÿฆ• Ensuring feature backward compatibilityโ€œ

Yeah, looking good ๐Ÿ‘

Thanyanit-J avatar Jul 15 '23 03:07 Thanyanit-J

IMHO, backwards compatibility (bwc) should be included in the original commit that added the new syntax, but I can kinda see why one would want to have this if something was forgotten

I prefer to add the backwards compatibility as a separate commit because:

  • git commits are supposed to be small and self-contained
  • I can revert the backwards compatibility commit later (once we don't have old-format data any more)

Having said that, the dinosaur idea ๐Ÿฆ• (:sauropod:) sounds great!

shankari avatar Jul 15 '23 04:07 shankari

I myself used ๐Ÿงฉ for this purpose, although it's more of a "general" compatibility, rather than backwards- specifically.

Chasmical avatar Dec 11 '23 16:12 Chasmical

I like the idea!

๐Ÿฆ– is just perfect for this proposal

carloscuesta avatar Dec 11 '23 17:12 carloscuesta