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

Improve legend for what's supported table and update all cells to reflect RC1 #567

Closed
roncain opened this issue Dec 2, 2015 · 5 comments
Assignees
Labels
documentation Documentation work is needed.
Milestone

Comments

@roncain
Copy link
Contributor

roncain commented Dec 2, 2015

2 parts to this task:

  1. Improve the granularity of the emoji's to distinguish better between "what works completely" to "what works for the paths we've tested"
  2. Go through and choose the right emoji's for each table cell
@roncain roncain added the documentation Documentation work is needed. label Dec 2, 2015
@zhenlan
Copy link
Member

zhenlan commented Dec 3, 2015

I think the granularity of current emoji's in the supported feature table is just right. Going into too much details will make it too hard to maintain. However, I do agree there is room for improvement of the definition of each emoji. Here is my proposal of update:

✅ -- Works with no known major issues
⚠️ -- Partially works with known issues or only partially tested
❌ -- Does not work
❓ -- Not yet tested

cc: @hongdai as the change of definition of the emoji's may affect her current PR.

@hongdai
Copy link
Contributor

hongdai commented Dec 3, 2015

I like the idea green means no major issues. Any different opinion?

✅ -- Works with no known major issues

@roncain
Copy link
Contributor Author

roncain commented Dec 3, 2015

It depends -- how do we define what a "major issue" is? I guess I would be okay with this if we still included a "more..." to describe what issues there are for this feature. Major to us may be different than major to a customer.

@zhenlan
Copy link
Member

zhenlan commented Dec 4, 2015

"Works with no known major issues" really means "Works with no known issues" to us. If we know any issues worth mentioning, we should use ⚠️ instead. But it is always possible there are corner cases we did not test and we have a bug, so that the word "major" is added is to leave some room and set proper expectations with customers.

@hongdai
Copy link
Contributor

hongdai commented Dec 4, 2015

Given we have been prioritizing major scenarios(p0 and p1) in our outerloop tests and unit test coverage is not high, it's very possible corner cases are missed.

@zhenlan zhenlan added this to the 2015.11&12 milestone Dec 8, 2015
@hongdai hongdai closed this as completed Dec 14, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation work is needed.
Projects
None yet
Development

No branches or pull requests

3 participants