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

Updated the README for Tutorials #3519

Merged
merged 11 commits into from
Aug 16, 2024
Merged

Conversation

cfeliciano7792
Copy link
Contributor

Description Of Changes

To improve the MetPy project, I updated the current README file for the tutorials. The goal was to provide clearer guidance and structure for users, making it easier for them to understand and utilize the tutorials effectively!

Files Changed

Updated README.md (located in the tutorials section):

  1. Purpose of the Tutorials:
    • Added a section explaining the objectives of the tutorials, detailing what users can expect to learn. This helps users
    understand the overall goal and the value of going through the tutorials.

  2. Link to Installation Guide and Examples Gallery:
    • Provided a link to the MetPy installation guide to make sure users had the required dependencies properly installed
    before attempting to complete a tutorial.
    • Included a link to MetPy’s example gallery so users can see what else they can create using MetPy.

  3. Descriptions of Current Tutorials:
    • Provided brief descriptions of each available tutorial. This gives users an overview of the content and helps them select
    tutorials that match their interests and needs.

  4. Categorization by Difficulty:
    • Organized the tutorials into sections based on their difficulty level (beginner, intermediate, advanced). This categorization
    assists users in selecting the appropriate tutorial according to their skill level, facilitating a smoother learning curve.

  5. Encouragement for Contribution:
    • I included a small section encouraging users to contribute to the tutorials with links to the contributors guide. Hopefully a
    user sees this message and feels encouraged to share their knowledge!

Checklist

@cfeliciano7792 cfeliciano7792 requested a review from a team as a code owner May 29, 2024 01:21
@cfeliciano7792 cfeliciano7792 requested review from dcamron and removed request for a team May 29, 2024 01:21
@CLAassistant
Copy link

CLAassistant commented May 29, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@dopplershift dopplershift left a comment

Choose a reason for hiding this comment

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

Apologies for not responding to this sooner!

This is an excellent contribution, and is a great step to making the tutorials seem like a nicer place for people to learn more about MetPy.

@dopplershift dopplershift merged commit 1f74454 into Unidata:main Aug 16, 2024
32 checks passed
@dopplershift
Copy link
Member

Congrats on your first PR to MetPy! 🎉 We hope to see you around in the future!

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.

Enhance the README in the Tutorials Section with Beginner-Friendly Details
3 participants