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.

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

create directory & readme file for discovery.js module #19

Closed
sethvincent opened this issue Aug 24, 2022 · 2 comments · Fixed by #29
Closed

create directory & readme file for discovery.js module #19

sethvincent opened this issue Aug 24, 2022 · 2 comments · Fixed by #29
Assignees
Labels
good first issue Good for newcomers

Comments

@sethvincent
Copy link
Contributor

sethvincent commented Aug 24, 2022

i think we're going to follow a pattern of each big module in the lib folder living in a directory with a README.md file, so we can start doing that with discovery.js

tasks:

  • move lib/discovery.js to lib/discovery/index.js
  • decide what these internal readme files should include (basic description, usage example, link to tests, what else?)
  • create README.md file with content
@sethvincent sethvincent added the good first issue Good for newcomers label Sep 8, 2022
@sethvincent sethvincent changed the title create readme file for discovery.js module create directory & readme file for discovery.js module Sep 8, 2022
@sethvincent
Copy link
Contributor Author

@achou11 here's what I've got so far for other module readmes in the lib directory: a1be680

Anything else we should have in there?

@achou11
Copy link
Member

achou11 commented Sep 8, 2022

@achou11 here's what I've got so far for other module readmes in the lib directory: a1be680

Anything else we should have in there?

can't think of anything else beyond what you listed :)

@ximenabb ximenabb moved this to Todo in Mapeo - Sprint 2022 Sep 13, 2022
@achou11 achou11 moved this from Todo to Code Review in Mapeo - Sprint 2022 Sep 14, 2022
Repository owner moved this from Code Review to Done in Mapeo - Sprint 2022 Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants