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.

Sign up for GitHub

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

Jump to bottom

Rework README #1001

Closed
bmtcril opened this issue Dec 13, 2024 · 3 comments · Fixed by #1002
Closed

Rework README #1001

bmtcril opened this issue Dec 13, 2024 · 3 comments · Fixed by #1002
Assignees
@that-ar-guy
Labels
documentation Relates to documentation improvements good first issue A good task for a newcomer to start with

Comments

@bmtcril
Copy link
Contributor

bmtcril commented Dec 13, 2024

Right now the README for this project has a mix of too much detailed information and not enough pointers to the actual docs. We should make a pass at cleaning this up and updating it to play nicely with our main docs.
@bmtcril bmtcril moved this to Ready for Work in Data Working Group Dec 13, 2024
@bmtcril bmtcril added documentation Relates to documentation improvements good first issue A good task for a newcomer to start with labels Dec 13, 2024
@that-ar-guy
Copy link
Contributor

Hey @bmtcril can i take up this issue

@Ian2012
Copy link
Contributor

Ian2012 commented Dec 13, 2024

Hey @that-ar-guy feel free to start working on it

@bmtcril
Copy link
Contributor Author

bmtcril commented Dec 13, 2024

@that-ar-guy Sure! Have you signed a contributor agreement for Open edX yet? https://openedx.atlassian.net/wiki/spaces/COMM/pages/941457737/How+to+Start+Contributing+Code

@that-ar-guy that-ar-guy mentioned this issue Dec 14, 2024
Merged
@github-project-automation github-project-automation bot moved this from Ready for Work to Done in Data Working Group Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@that-ar-guy that-ar-guy

Labels
documentation Relates to documentation improvements good first issue A good task for a newcomer to start with
Projects
Data Working Group
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Reworked README for improved clarity that-ar-guy/tutor-contrib-aspects
3 participants
@Ian2012 @bmtcril @that-ar-guy