Replies: 3 comments 3 replies
-
we could refer other graduated/top ASF projects first: then refer other incubating projects, and everyone could give some suggestion here 💬 |
Beta Was this translation helpful? Give feedback.
-
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. |
Beta Was this translation helpful? Give feedback.
-
And also we do need an architecture picture in the README & website |
Beta Was this translation helpful? Give feedback.
-
我这边有几个问题想在社区中寻求讨论和帮助。
I have a few issues that I would like to discuss and help in the community.
什么内容需要放在 Readme 里面,可以让大家更清晰了解hugegraph?
What content needs to be placed in Readme, so that everyone can understand Hugegraph more clearly?
多长篇幅的 Readme 适宜阅读,能够关注到足够的重点又不失去耐心呢?
How long is Readme suitable for reading, can you pay attention to focus on the right points without losing patience?
目前我这边提了一个pull request,详情请看pull request 连接,更改了部分 Readme 内容,欢迎大家一起讨论。
Now I have put forward a pull request, please see the details here, some Readme content has been changed, welcome to discuss together.
Beta Was this translation helpful? Give feedback.
All reactions