conda / ceps

Conda Enhancement Proposals
Creative Commons Zero v1.0 Universal
19 stars 24 forks source link

Proposal: Add Emojis to the CEPS #3

Open LtDan33 opened 3 years ago

LtDan33 commented 3 years ago

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?

jezdez commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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 commented 2 years ago

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