GitHub user liuxiaocs7 edited a comment on the discussion: What should be in the Readme?
Hi, community, I've browsed the READMEs of the above projects and some other Apache projects, the common contents include brief introduction, features, build process, contribution guide, License, community contact points. Some may also include usage examples, and keep the README content as concise as possible, unnecessary unnecessary content can be put into the official website instead of the README. For the changes in PR #2227, I think the diagrams of Contributor and Stargazers, Contributors graph are unnecessary (maybe in website is better?) and License should not be removed. @imbajin What do you think? GitHub link: https://github.com/apache/incubator-hugegraph/discussions/2229#discussioncomment-6121911 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected]
