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 an extractor template repository #585

Open
max-zilla opened this issue Jun 6, 2019 · 3 comments
Open

Create an extractor template repository #585

max-zilla opened this issue Jun 6, 2019 · 3 comments

Comments

@max-zilla
Copy link
Contributor

max-zilla commented Jun 6, 2019

Follow the instructions on how to use GitHub's template repository feature https://help.github.com/en/articles/creating-a-template-repository

The goal of this is to provide developers with a framework to help guide them toward following the consistent implementation of extractors.

This can include:

  • use of terrautils and other support libraries
  • test directory, etc.
  • README
  • extractor (Clowder) pieces vs. algorithm (science) pieces

First steps

  • create a new repository as a template
  • identify a prototypical extractor
  • duplicate it and push to the template repository
  • pull out the specific stuff
  • add instructions
    • pointers to documentation
    • summary of the git workflow
    • pointers to other exemplar extractors
  • and stubs for
    • documentation
    • science code
    • tests
@max-zilla max-zilla added this to the TERRA Sprint - June 2019 milestone Jun 6, 2019
@max-zilla
Copy link
Contributor Author

max-zilla commented Jun 6, 2019

push terrautils documentation to readthedocs moved to separate issue #588

@max-zilla
Copy link
Contributor Author

@tcnichol @Chris-Schnaufer FYI.

@dlebauer
Copy link
Member

dlebauer commented Jun 7, 2019

In summary, this should embed all of the information currently contained in our documentation https://docs.terraref.org/developer-manual/developing-clowder-extractors in order to make it easier for authors to find, reference, and understand what is required.

  • coincidentally GitHub announced formal support for a template repositories on the same day this issue was posted! https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/

  • We should check out other template repositories to see what is available and learn from what other projects have done.

  • We should get feedback from contributors including @ZongyangLi, @Andrewzhzy, @abby621, @Paheding ... comments welcome now, but especially after we have a first draft of such a template.

  • I'd be happy to take a stab at some of the details once some of the structure is set up.

@dlebauer dlebauer changed the title Extractor template Create an extractor template repository Jun 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants