opensearch-project / opensearch-sdk-py

OpenSearch Extensions SDK for Python.
https://opensearch.org/blog/introducing-extensions-for-opensearch/
Apache License 2.0
9 stars 7 forks source link

[PROPOSAL] Encourage XKCD references #58

Open dblock opened 11 months ago

dblock commented 11 months ago

What/Why

What are you proposing?

On several occasions we see XKCD references in issues and discussions (e.g. in additional context in https://github.com/opensearch-project/opensearch-sdk-py/issues/57). I propose we add a section on encouraging the use of XKCD in this project to DEVELOPER_GUIDE, and maybe link https://findxkcd.com.

What users have asked for this feature?

Every. Single. User.

What problems are you trying to solve?

What is the developer experience going to be?

Are there any security considerations?

Are there any breaking changes to the API

What is the user experience going to be?

Are there breaking changes to the User Experience?

Why should it be built? Any reason not to?

What will it take to execute?

Any remaining open questions?

dbwiddis commented 11 months ago

+1, although your examples above give multiple examples of different standards. I propose we simplify to a single standard.

image

dblock commented 11 months ago

dbwiddis commented 11 months ago

image