Awesome Guidelines

[matheusgmaia]

I tried to add this awesome on the main awesome list but it doesn't follow some guidelines:

Missing guidelines "Main awesome"

Whats the author/contributors opinion on changing the format so this nice awesome can make the list?

[jphall663]

Sorry for the delay. I am open to this.

[jphall663]

@matheusgmaia here are my thoughts:

• The heading title of your list should be in title case format: # Awesome Name of List.

  • :white_check_mark: Awesome Machine Learning Interpretability

• Includes a project logo/illustration whenever possible (for your list, there may not be an image though).

  • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
  • The image should link to the project website or any relevant website.
  • The image should be high-DPI. Set it to maximum half the width of the original image.

    Hmmm ... any ideas here? Can this be the existing image? Or this image:https://github.com/jphall663/responsible_xai/blob/master/img/hc_ml.png ?

• Has a Table of Contents section.

  • :white_check_mark: Should be named Contents, not Table of Contents.

• Also, consider sticking to the following format for link items:

  • Link - Description.
  • Often, you just have long descriptive links or links with no description.

    This could take alot of work. Can this be ignored?

[jphall663]

Still haven't forgotten about this ...