Skip to content
This repository has been archived by the owner on May 5, 2020. It is now read-only.

Make ReadMe.md more interactive #395

Closed
1 of 3 tasks
anubhavpulkit opened this issue Apr 11, 2020 · 15 comments
Closed
1 of 3 tasks

Make ReadMe.md more interactive #395

anubhavpulkit opened this issue Apr 11, 2020 · 15 comments

Comments

@anubhavpulkit
Copy link
Contributor

anubhavpulkit commented Apr 11, 2020

Description

As a user, I want to add some screenshots of PowerUp app, margins and redesign Readme.md
so that [Readme file looks more interactive and decent not so bulky].

Acceptance Criteria

Update [Required]

  • [Changes in Readme.md]

Definition of Done

  • All of the required items are completed.
  • Approval by 1 mentor.

Estimation

[2] hours

@anubhavpulkit
Copy link
Contributor Author

Any newcomer who wants to work on this issue?

@nandini45
Copy link
Member

yeah i want to @AnubhavSingh16

@anubhavpulkit
Copy link
Contributor Author

@isabelcosta Please have a look this issue and assign to @nandini45.

@isabelcosta
Copy link
Member

done @AnubhavSingh16 :)

@anubhavpulkit
Copy link
Contributor Author

@isabelcosta Can I mentor this issue, please.

@sunjunkie
Copy link
Contributor

@AnubhavSingh16 Regarding the description text ""I need [to do remove some points of Contributing and developing a feature and add some emojis and images]" - this is implementation and does not belong in the user story.

@isabelcosta
Copy link
Member

@AnubhavSingh16 what do you mean by mentor exactly? One good thing you could do is be more descriptive and clear in the issue description. If your issue is clear on the Acceptance Criteria and Definition of Done you are closer to helping the contributor understanding by themselves what they need to do ;)

What exactly are you suggesting with this issue, what are some suggestions you have for it to be more "interactive and decent"?

@sunjunkie
Copy link
Contributor

The user story starts out "as a user". So what do I want as a user? The user does not care specifically about margins or adding screenshots, for example. What do you think the user wants from the readme that is not there and why? You should answer that question without thinking about how you want to fix the readme. :-)

@anitab-org anitab-org deleted a comment from anubhavpulkit Apr 13, 2020
@sunjunkie
Copy link
Contributor

BTW, I deleted one of your comments only because you mentioned an unrelated PR in the comment. That messes up the connections between issues and PRs...

@anubhavpulkit
Copy link
Contributor Author

As a user, I want to understand the PowerUp project in detail and there functions with some images,
I need [to add some images and remove some unnecessary things from README.md],
so that I can [Understand the function of PowerUp-iOS].

@anubhavpulkit
Copy link
Contributor Author

Actually @sunjunkie if you look out README of PowerUp-iOS, it looks like we describe the functionality of git in Readme, I can't find anything about PowerUp in Readme section.

@nandini45
Copy link
Member

@AnubhavSingh16 can you tell me any specific details which is required or some mandatory features so that i can edit and make the changes

@anubhavpulkit
Copy link
Contributor Author

@nandini45 You have to wait a little bit for approval of this issue.

@sunjunkie
Copy link
Contributor

sunjunkie commented Apr 15, 2020

@AnubhavSingh16 yes, that’s exactly right. You can’t find anything about Powerup in the readme. That is the user’s problem. “Adding images” and “removing unnecessary things” does not describe what the user wants so it doesn’t belong in the user story. The user wants to understand something about the goals and functionality of the Powerup app. The user does not care how you convey that info to them. There are multiple ways to do that: screen shots, more details, videos, tutorials ...

@sunjunkie
Copy link
Contributor

I am going to close this. We can start over with a better user story.

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

No branches or pull requests

4 participants