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

README update suggestion #312

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Haoyu-Gao
Copy link

We have made some updates to the project’s README file, please take a look at the pull request and tell me about your thoughts on it.

About
This is part of a research project that aims to study whether a templated presentation of README file could help improve the comprehension of the users and reduce the practitioners’ maintenance efforts for README file. The template image is attached as follows.

template-section.pdf

This pull request restructures the README file to improve readability and navigation, making it easier for users to find essential information quickly. The changes focus on:

  • Reorganizing sections for logical flow
  • Enhancing headers for better section clarity
  • Streamlining content to highlight key information

These updates aim to support new users and contributors by presenting a more accessible and informative README. A templated update also aims to remind the documentation maintainers of essential information to include when performing README updates.

@BWibo
Copy link
Member

BWibo commented Nov 15, 2024

Hey there, thx for the contribution.
I just went through this. In my opinion this is not a significant improvement. Some sections that are important for us, like the partners and supporters and additional information about the technical standards behind the project are missing.
We appreciate your effort, but for now I'd rather stick to the existing version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants