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

Improve CocoaPods quality estimate #81

Open
SteveFortune opened this issue Nov 15, 2015 · 1 comment
Open

Improve CocoaPods quality estimate #81

SteveFortune opened this issue Nov 15, 2015 · 1 comment
Milestone
2.1.0

Comments

@SteveFortune
Copy link
Member

We have 61 points: https://cocoapods.org/pods/BetweenKit/quality. Our short README affects this adversely.

Here is an example of a pod with a high quality estimate: https://cocoapods.org/pods/AFNetworking/quality.

We can do the following to improve this metric:

  • Add changelog
  • Add Doxygen docs
  • Better metadata around where our documentation lies
  • Expand on README (background, quick start guide)
@SteveFortune SteveFortune added this to the 2.1.0 milestone Jan 20, 2016
@SteveFortune
Copy link
Member Author

We have 66 points. Looks like the main thing letting us down is our 'Minimal README'. I'm not sure what we can add here; perhaps a simplified version of Usage? Or an index of the Docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
2.1.0
Development

No branches or pull requests
1 participant
@SteveFortune