Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Add Emojis to the CEPS #3

Open
LtDan33 opened this issue Aug 18, 2021 · 5 comments
Open

Proposal: Add Emojis to the CEPS #3

LtDan33 opened this issue Aug 18, 2021 · 5 comments
Labels
enhancement New feature or request

Comments

@LtDan33
Copy link
Member

LtDan33 commented Aug 18, 2021

Since each CEP is a single file, could use a emoji to signify its status? You can add these to the front of the commit message/PR. This would allow us to quickly see at a glance what the status of things are. I tried an example in the CEP-4 branch

🔨 for Draft
🛠️ Proposed
✔️ Accepted
➖ Rejected
✅ Implemented
⚡ Deferred (Not sure on this one)

@jezdez what do you think?

@LtDan33 LtDan33 added the enhancement New feature or request label Aug 18, 2021
@jezdez
Copy link
Member

jezdez commented Aug 19, 2021

Hmm, I'd be worried about emoji in commit messages personally since it makes the commit log messy in the git log output and GitHub history view. Since commit messages are forever I'd keep it simple with those for now. There is also a bit of an issue for people that don't have a font with Emoji support installed for their command line (e.g. older Windows).

Alternatively, would having a listing of the current CEPs in the README with emojis help with the overview problem? E.g. a simple Markdown table like this:

Title Status
CEP 0 CEP template ✔️
CEP 1 CEP Purpose and Guidelines 💬
CEP 2 Add plugin architecture to Conda ✔️
CEP 3 Using the Mamba solver in Conda 🚧

BTW, here'd be my proposal for the set of emojis:

🚧 for Draft
💬 Proposed
✔️ Accepted
➖ Rejected
🎉 Implemented
🔙 Deferred (Not sure on this one)

@LtDan33
Copy link
Member Author

LtDan33 commented Aug 19, 2021

Good points. Yeah maybe having it in the readme would work. I think it would be just very easy to then see which ones someone could maybe look at if they are wanting to, and its part of the flow. We could use labels too, but I don't think they work as well due to needing to work just with a github function and is outside the actual code/files

@csoja
Copy link

csoja commented Aug 19, 2021

I like the idea of this information being in the Readme and kept up to date.
I like the emojis that Jannis proposed - those are all very clear to me.

@jaimergp
Copy link
Contributor

Self writing READMEs are nice for this. There are some examples in those fancy profile page READMEs. I can work on that if needed.

@kenodegard
Copy link
Contributor

I agree that this should be implemented as a self writing README, otherwise it will absolutely become a pain to maintain. Is the idea to create a scheduled GitHub action that regenerates the index at some interval? Or is it preferred to use a bot/action that regenerates the index as part of the PR?

A few other options for the deferred icon:
⏳ - it's waiting on ______
⏸️ - it's on pause
🛑 - it's been blocked
📌 - we've put a pin in it
🗄️ - it's been filed away

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants