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

Restructure README.md content #1255

Closed
2 tasks done
kvignesh1420 opened this issue Jan 4, 2021 · 1 comment
Closed
2 tasks done

Restructure README.md content #1255

kvignesh1420 opened this issue Jan 4, 2021 · 1 comment

Comments

@kvignesh1420
Copy link
Member

kvignesh1420 commented Jan 4, 2021

The development section in the README.md file is not only being used to document instructions for the developers but is also used by Github Actions CI jobs. This section consumes a lot of space which might overwhelm new developers/contributors who just want to get a brief idea about the project through the README.md file.

Build Status section should be updated as new datasets have been added and the python version for CI builds have changed.

Suggested plan:

Will create PR's as per these items.
cc: @yongtang @terrytangyuan @BryanCutler @vlasenkoalexey for suggestions.

@yongtang
Copy link
Member

yongtang commented Jan 4, 2021

Sounds good to me 👍

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

No branches or pull requests

2 participants