README.md

Cyfrin Updraft

The ultimate learning platform for web3 developers

Welcome to the official GitHub repository for Cyfrin Updraft. This repository houses the written content of our courses, organized to facilitate easy access and contribution from our community. Please refer to this for an in depth explanation of the content:

• Website - Join Cyfrin Updraft and enjoy 50+ hours of smart contract development courses
• Twitter - Stay updated with the latest course releases
• LinkedIn - Add Updraft to your learning experiences
• Discord - Join a community of 3000+ developers and auditors
• Newsletter - Weekly security research tips and resources to level up your career
• Codehawks - Smart contracts auditing competitions to help securing web3

Have a question about the courses?

• Join us on Discord
• Or refer to the courses' GitHub discussions repositories linked on the lesson pages

Repository Structure

Our content is structured as follows:

• courses/
  • course_name/
    • section_name/
      • lesson_name/
        • lesson_content.md

Each course is contained within its directory, and for each course, you will find directories for each lesson, which contain a Markdown file (.md) with the lesson's content.

How to Contribute

We deeply value every kind of community contribution:

• Correcting typos or subtitles
• Enhancing code snippets
• Refining our educational content

Here's how you can contribute:

Prerequisites

• Familiarity with GitHub and basic Markdown syntax.
• Understanding of the specific course material you wish to contribute to.

Steps for Contribution

1. Fork the Repository: Start by forking the Cyfrin Updraft repository to your GitHub account.

2. Clone the Forked Repository: Clone your forked repository to your local machine for easy editing.

   git clone https://github.com/your-username/Updraft.git
   cd Updraft

3. Create a New Branch: Create a new branch for your changes. Use a clear branch name that reflects the nature of your contribution.

   git checkout -b your-branch-name

4. Make Your Changes: Navigate to the specific course and lesson you wish to update and make your changes in the Markdown file.

5. Commit Your Changes: Once you've made your changes, commit them with a clear and concise commit message.

   git add .
   git commit -m "A brief description of your changes"

6. Push Changes to GitHub: Push your changes to your forked repository.

   git push origin your-branch-name

7. Create an Issue: This repo reviews pull requests that have an associated issue, so please make an issue and tag the issue somewhere in your pull request (which you'll make in the next step).

8. Create a Pull Request (PR): Go to the original Cyfrin Updraft repository on GitHub and create a pull request from your forked repository. In your PR, explain the changes you've made and why they're beneficial.

9. Await Review: The Cyfrin team or community maintainers will review your PR. Be responsive to any feedback or requested changes.

Best Practices for Contribution

• Small, Focused Changes: Keep your changes focused on a single issue or improvement for easier review and merging.

• Follow the Style Guide: Ensure your contributions adhere to the existing style and formatting of the lessons.

• Update Documentation: If your changes are significant, update the relevant documentation within the same PR.

• Respect the Community: Engage constructively with the community and maintain the ethos of collaboration and respect.

Reporting Issues

Encounter an issue or have a suggestion? Open an issue on this repository with a clear, descriptive title and detailed information.

Credits

This project exists thanks to all the people who contribute.

License

Cyfrin Updraft content is open-sourced licensed as GPLv3.