Skip to content
This repository has been archived by the owner on Nov 29, 2021. It is now read-only.

Suggestion: improve readme to help people reuse this #12

Open
3 of 4 tasks
brittag opened this issue Feb 24, 2016 · 6 comments
Open
3 of 4 tasks

Suggestion: improve readme to help people reuse this #12

brittag opened this issue Feb 24, 2016 · 6 comments

Comments

@brittag
Copy link
Contributor

brittag commented Feb 24, 2016

It'd be nice to add some basic info to this readme since people inside and outside 18F may be interested in reusing a glossary widget for future projects. Suggestions:

  • Add brief introduction to what this does
  • Explain the status of the code (is this usable? still experimental? an experimental forked version of a usable thing found elsewhere?)
  • Link to examples of the glossary in use (such as beta FEC and US EITI)
  • Ideally link to the files in those projects where those versions of the glossary code are living
@afeld
Copy link
Contributor

afeld commented Feb 29, 2016

I believe most of these will be taken care of by #6, which I will theoretically get time to go back to someday.

@psswf1172
Copy link

Pushed small edits to existing readme to address remaining asks in this issue. Otherwise, resolved.

@afeld
Copy link
Contributor

afeld commented Apr 11, 2016

@psswf1172 Hmm, I think something went wrong when you were trying to submit them...the only commit I'm seeing of yours is https://github.com/psswf1172/18f-glossary/commit/51b1b3c4747ec8844ac09238c75abbceaf4d98f3. Would you mind deleting your fork (from the settings page), re-forking, and trying to commit and send a pull request again?

@mvattuone
Copy link
Contributor

@afeld Is this issue still current? I see the check marks but couldn't tell based on the chatter.

@afeld
Copy link
Contributor

afeld commented Oct 12, 2017

I think the last checkbox is still relevant, yeah.

@jeremykohn
Copy link

jeremykohn commented Nov 9, 2017

Now that #32 is merged, should this issue be closed as well? @afeld @mvattuone

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
No open projects
Development

No branches or pull requests

5 participants