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

Add quickstart to README #789

Merged
merged 1 commit into from
Aug 19, 2024
Merged

Add quickstart to README #789

merged 1 commit into from
Aug 19, 2024

Conversation

mfisher87
Copy link
Member

@mfisher87 mfisher87 commented Aug 19, 2024

Currently, the README doesn't give a feel for what earthaccess does. This helps the user envision how they would use it right way. The README should act as the top of the funnel into our docs. It's wide and shallow and guides people to the depth they are looking for.

Pull Request (PR) draft checklist - click to expand
  • Please review our
    contributing documentation
    before getting started.
  • Ensure an issue exists representing the problem being solved in this PR.
  • Populate a descriptive title. For example, instead of "Updated README.md", use a
    title such as "Add testing details to the contributor section of the README".
  • Populate the body of the pull request with:
  • Update CHANGELOG.md with details about your change in a section titled
    ## Unreleased. If such a section does not exist, please create one. Follow
    Common Changelog for your additions.
  • Update the documentation and/or the README.md with details of changes to the
    earthaccess interface, if any. Consider new environment variables, function names,
    decorators, etc.

Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub
once these requirements are fulfilled. Don't worry if you see any test failures in
GitHub at this point!

Pull Request (PR) merge checklist - click to expand

Please do your best to complete these requirements! If you need help with any of these
requirements, you can ping the @nsidc/earthaccess-support team in a comment and we
will help you out!

  • Add unit tests for any new features.
  • Apply formatting and linting autofixes. You can add a GitHub comment in this Pull
    Request containing "pre-commit.ci autofix" to automate this.
  • Ensure all automated PR checks (seen at the bottom of the "conversation" tab) pass.
  • Get at least one approving review.

📚 Documentation preview 📚: https://earthaccess--789.org.readthedocs.build/en/789/

@mfisher87 mfisher87 marked this pull request as ready for review August 19, 2024 21:19
@mfisher87
Copy link
Member Author

We need to migrate to Ruff 0.6.0 to get these linting errors to quiet down.

Copy link
Member

@asteiker asteiker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good, basic example to include here!

@mfisher87 mfisher87 merged commit f5283fa into main Aug 19, 2024
15 of 17 checks passed
@mfisher87 mfisher87 deleted the readme-quickstart branch August 19, 2024 23:11
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

Successfully merging this pull request may close these issues.

2 participants