[GitHub] [accumulo] nicolasalarconrapela commented on pull request #2068: Update and improvement in README

[GitBox <gi...@apache.org>]

nicolasalarconrapela commented on pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#issuecomment-831108708


   > For the README, consider these guidelines:
   > 
   > 1. Keep it minimal; only show basics, and defer to the project website for more
   > 2. Keep it readable in both plain text Markdown and in the Markdown-rendered HTML
   > 3. Make it look nice on GitHub, with badges, but don't go overboard so that it hurts plain text readability
   > 4. Use footnote links instead of inline links so that the reader doesn't have to interrupt reading to view a URL
   > 5. Don't use relative links to files not present in the tarball distribution
   > 6. Don't use links to resources whose address is likely to change
   > 7. Don't link to the source code repository
   > 8. Avoid emojis, unnecessary graphics, and unnecessary special characters
   
   I see fit that these guidelines should be saved or mentioned somewhere in case some other user decides to modify the README.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org