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

Update README.md #75

Merged
merged 7 commits into from
Mar 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 0 additions & 34 deletions .github/workflows/update-json.yml

This file was deleted.

20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,20 @@ Our content is structured as follows:

- `courses/`
- `course_name/`
- `lesson_name/`
- `lesson_content.md`
- `section_name/`
- `lesson_name/`
- `lesson_content.md`

Each course is contained within its own directory, and within each course, you will find directories for each lesson, which contain a Markdown file (.md) with the lesson's content.
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 community contributions, whether it's correcting typos, enhancing code snippets, or refining our educational content. Here's how you can 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

Expand Down Expand Up @@ -114,7 +120,7 @@ We deeply value community contributions, whether it's correcting typos, enhancin

7. **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.

8. **Await Review:** Your PR will be reviewed by the Cyfrin team or community maintainers. Be responsive to any feedback or requested changes.
8. **Await Review:** The Cyfrin team or community maintainers will review your PR. Be responsive to any feedback or requested changes.

### Best Practices for Contribution

Expand All @@ -139,7 +145,7 @@ This project exists thanks to all the people who contribute.<br>

## License

Cyfrin Updraft content is open sourced [licensed as GPLv3](https://github.com/cyfrin/updraft/blob/main/LICENSE).
Cyfrin Updraft content is open-sourced [licensed as GPLv3](https://github.com/cyfrin/updraft/blob/main/LICENSE).


[![Cyfrin Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/cyfrinupdraft)
Expand All @@ -152,4 +158,4 @@ git clone https://github.com/Cyfrin/Updraft
cd Updraft
pnpm install
pnpm dev
```
```
57 changes: 0 additions & 57 deletions update_json.js

This file was deleted.