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

Fix #560: Create Oppia Android README #1722

Merged
merged 4 commits into from
Sep 23, 2020
Merged

Fix #560: Create Oppia Android README #1722

merged 4 commits into from
Sep 23, 2020

Conversation

BenHenning
Copy link
Member

@BenHenning BenHenning commented Aug 27, 2020 •
edited
Loading

Fix #560.
Fix part of #1723.

Introduce a README for the repository, including badges for our GitHub actions runs & Gitter channel. This README is heavily based on Oppia web/backend's: https://github.com/oppia/oppia/blob/develop/.github/README.md.

@BenHenning
Copy link
Member Author

BenHenning commented Aug 27, 2020 •
edited
Loading

Note that I'm thinking we can add a few pictures once the alpha content is ready to be loaded into a binary (@rt4914 FYI).

@BenHenning BenHenning changed the title Create Oppia Android README Fix #560: Create Oppia Android README Aug 27, 2020
@BenHenning
Copy link
Member Author

@anandwana001 & @rt4914: do you think this README is sufficient per your notes in #560?

anandwana001
anandwana001 suggested changes Aug 27, 2020
View reviewed changes
Copy link
Contributor

@anandwana001 anandwana001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Put a few of my thoughts here.

.github/README.md Outdated Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
.github/README.md Show resolved Hide resolved
.github/README.md Outdated Show resolved Hide resolved
@rt4914
Copy link
Contributor

rt4914 commented Aug 27, 2020

@anandwana001 Just assign it back to me once your comments are resolved considering it will change the readme a lot and also most of the things will get convered.

@rt4914 rt4914 removed their assignment Aug 27, 2020
@BenHenning
Update README.md
9351190 
Address review comments.
@BenHenning
Copy link
Member Author

Thanks @anandwana001! I appreciate your thorough review. PTAL at the latest changes.

anandwana001
anandwana001 approved these changes Sep 22, 2020
View reviewed changes
Copy link
Contributor

@anandwana001 anandwana001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Thanks @BenHenning This seems amazing.

.github/README.md Outdated Show resolved Hide resolved
@anandwana001
Copy link
Contributor

Are we adding License to Readme?

@BenHenning
Copy link
Member Author

Isn't the license being referenced in the ## License section, or am I missing something @anandwana001?

Also, is this ready for me to follow-up on or are you still reviewing it (per the assignments)?

@anandwana001
Copy link
Contributor

Isn't the license being referenced in the ## License section, or am I missing something @anandwana001?

Also, is this ready for me to follow-up on or are you still reviewing it (per the assignments)?

Ah, I missed it, got the license now.
I was checking the ticket thing, but assigning to you now.

@BenHenning
Update README.md
edcedf8 
Address reviewer comments: add link for coding contribution instructions, and add badge for newcomer issues.
@BenHenning BenHenning assigned anandwana001 and rt4914 and unassigned rt4914 and BenHenning Sep 22, 2020
@BenHenning
Copy link
Member Author

BenHenning commented Sep 22, 2020 •
edited
Loading

Thanks @anandwana001. Addressed your comments, PTAL.

@rt4914 also PTAL when you get a chance--I would like to know if you have any thoughts on what should go into the README.

rt4914
rt4914 approved these changes Sep 22, 2020
View reviewed changes
Copy link
Contributor

@rt4914 rt4914 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good and can easily be verified in next couple of days by new contributors. Thanks.

@rt4914 rt4914 assigned BenHenning and unassigned rt4914 Sep 22, 2020
@anandwana001 anandwana001 removed their assignment Sep 22, 2020
@BenHenning
Copy link
Member Author

Thanks. @anandwana001 please confirm final comment thread, then I can merge.

@BenHenning
Copy link
Member Author

Thanks everyone! Going ahead and merging this now.

@BenHenning BenHenning merged commit 44cf787 into develop Sep 23, 2020
@BenHenning BenHenning deleted the add-oppia-android-readme branch September 23, 2020 16:13
prayutsu pushed a commit to prayutsu/oppia-android that referenced this pull request Sep 25, 2020
@BenHenning @prayutsu
Fix oppia#560: Create Oppia Android README (oppia#1722)
3b34696 
* Create Oppia Android README

* s/Oppia/Oppia Android/ in the title

* Update README.md

Address review comments.

* Update README.md

Address reviewer comments: add link for coding contribution instructions, and add badge for newcomer issues.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anandwana001 anandwana001 anandwana001 approved these changes

@rt4914 rt4914 rt4914 approved these changes

Assignees

@BenHenning BenHenning

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add README.md
3 participants
@BenHenning @rt4914 @anandwana001