Badgeyay: Readme Improvement

Created on 25 Sep 2017  路  13Comments  路  Source: fossasia/badgeyay

I'm submitting a ...

  • [ ] bug report
  • [x] feature request

Current behavior:

A minor fix in the README.md

Expected behavior:

  • [x] Branches are very important for a repository. Need of a section with an anchor link which describes the branch-policy. link
  • [x] A section of describing the license of use-case of the repository under FOSSASIA. (link)(https://github.com/fossasia/open-event-webapp#license)
  • [x] The technologies you are using in the repository and how it works link.
  • [x] Few people have slow internet connection so a gif include in the README.md is not a bad idea.
  • [ ] A rule which includes updating the progress, so if the assignee is not updating the progress, other can carry out the job.

Look into the repository of which is the links are attached and further you can give your own idea and contribute.

Steps to reproduce:
NA

Enhancement Help Wanted

All 13 comments

@meets2tarun Can we break this into small sub-issues for point 3 and 4 for new-comers?

@vaibhavsingh97 Go for it!

@meets2tarun Readme now alreday have link to Youtube video, we still need point 4?

@meets2tarun we can have a rule such that any assignee will have to update the progress in every 2 days , if he is facing problem then others can work on it . Your views ?

@meets2tarun what should be in gif ?

Gif must be a walkthrough of the application.

Means it will have what we have in YouTube video.Right ?

As I mentioned that everyone doesn't have a fast internet connection, so basically gif is for those people only.

@ParthS007
I mean to state that if he is facing difficulty or not able to proceed further or not working on the task although the task has been assigned to him, then a rule that after a certain interval of time that person will dissociate from the task or something like that.

Yes, agreed.I am saying the same thing but time interval given depends on issue' complexity which we will have to discuss.Your views @gabru-md @vaibhavsingh97

I am working on gif part @meets2tarun.

We need to solve the rest of the checkpoint.

@meets2tarun @vaibhavsingh97 I would like to add license of use-case of the repository under FOSSASIA in the readme by editing this https://github.com/fossasia/open-event-webapp#license as mentioned.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

niccokunzmann picture niccokunzmann  路  7Comments

mariobehling picture mariobehling  路  7Comments

ParthS007 picture ParthS007  路  5Comments

ParthS007 picture ParthS007  路  6Comments

ananyo2012 picture ananyo2012  路  4Comments