Skip to content

Commit

Permalink
(CI) Run Prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 4, 2024
1 parent 89c3a45 commit 626d1da
Showing 1 changed file with 37 additions and 28 deletions.
65 changes: 37 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ Welcome to **Animation Nation**, a fun and creative project by the [ZTM Communit
This repository is a space where developers of all levels, especially **beginners**,
can contribute, showcase their creativity.
Whether you're a seasoned developer or writing your first line of code,
we'd love to see your animated artwork using only **HTML** and **CSS**
we'd love to see your animated artwork using only **HTML** and **CSS**

> [!IMPORTANT]
> no **JavaScript** or **images** or **SVG** allowed!
Expand All @@ -21,41 +22,45 @@ we'd love to see your animated artwork using only **HTML** and **CSS**
- **Join a supportive community** where you can share your creativity and get feedback in our Discord.
- **Enhance your skills** in HTML and CSS while learning GitHub workflows.



## 🎯 Objective Overview

Create an animation using CSS and HTML only (no JavaScript, no SVG).
A [CSS animation](https://developer.mozilla.org/fr/docs/Web/CSS/animation) refers to the css rule `animation`.

The purpose is to display a creative and looping animation
*( alike animation in GIFs )*
_( alike animation in GIFs )_

### Should

- the animation should be looping
- the animation should not require any user interaction ( click, hover, etc ... )

### Should not

An animation should not be:

- a form,
- a portfolio,
- a button to click on,
- a button to click on,
- a landing page, etc...
*( which are elements requiring user interaction )*
_( which are elements requiring user interaction )_

Here is an example of an expected animation:
<img src="./public/example-animation.gif" alt="triangle" />

### ☝️ Keep in mind

We keep things simple! Here are the rules for contributing:

- Use **HTML** and **CSS** only. No **JavaScript**. No **Images/SVGs**.
- Your project must include **at least one animation**.
- Don't copy work from others. Make sure your code is **original** so you can showcase your own skills.


## 🚀 How to contribute

> [!TIPS]
> 📌 Don't worry if it's your first time contributing—below,
we've got detailed steps and resources to help you get started!***
> we've got detailed steps and resources to help you get started!\*\*\*
<details>
<summary>💡 Development Workflow</summary>
Expand All @@ -75,13 +80,14 @@ we've got detailed steps and resources to help you get started!***
<br>

We keep things simple! Here are the rules for contributing:

- Use **HTML** and **CSS** only. No **JavaScript**. No **Images/SVGs**.
- Your project must include **at least one animation**.
- Don't copy work from others. Make sure your code is **original** so you can showcase your own skills.

<br />

### 🔥 Contribution Guide: Step-by-Step
### 🔥 Contribution Guide: Step-by-Step

#### 1. Fork This Repository

Expand All @@ -98,7 +104,7 @@ Check out these beginner-friendly resources for more help:

#### 2. Clone Your Fork

Once you've forked the repo, clone it to your local machine
Once you've forked the repo, clone it to your local machine
so you can work on it.
Use this command:

Expand All @@ -109,32 +115,33 @@ git clone https://github.com/<your-github-username>/Animation-Nation.git
<br>

#### 3. Create A Branch

Create a new branch from `master` or `main`
*Working in the `master` or `main` branch is often frowned upon
_Working in the `master` or `main` branch is often frowned upon
and are usually expected to branch off. Branching also helps
to reduce the chance of a merge conflict.*
to reduce the chance of a merge conflict._

<br>


#### 4. Create Your Artwork

Now for the fun part! Inside the `Art/` folder:

> [!WARNING]
> It is important to name the directory and your files exactly as mentioned
> [!NOTE]
> Per contribution folder: it should have only 3 files [ `index.html`, `styles.css`, `meta.json` ]
> Per contribution folder: it should have only 3 files [ `index.html`, `styles.css`, `meta.json` ]
- Create a new directory named:
`<github_username>-<art_name>` eg. `mattcsmith-helloworld`.
`<github_username>-<art_name>` eg. `mattcsmith-helloworld`.
- Inside **your** folder, create an `index.html` file
- Inside **your** folder, create an `styles.css` file
- Inside **your** folder, create an `meta.json` file
to specify your art name, github author and github link
Note:
- copy the following snippet ( without the comment )
- and replace only the values with your own details.
- and replace only the values with your own details.
- Do not change the JSON keys

```json
Expand All @@ -154,20 +161,21 @@ Now for the fun part! Inside the `Art/` folder:
After completing your artwork, you are now ready to create
a pull request and have it added to the collection.

Remembering

Remembering
- to first **pull down** the recent changes from to the upstream,
- **commit** your changes,
- to first **pull down** the recent changes from to the upstream,
- **commit** your changes,
- **push** them to your forked repo,
and submit a PR.
If you're unfamiliar with pull requests, check out the following resources
or drop a message in the Hacktoberfest channel on Discord.
and submit a PR.
If you're unfamiliar with pull requests, check out the following resources
or drop a message in the Hacktoberfest channel on Discord.
- [Creating a Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
- [Aldo's Contributing to Github video](https://www.youtube.com/watch?v=uQLNFRviB6Q)

<br>

#### 6. OPTIONAL - Tweet about your progress

Optionally you can [Tweet about making your first Hacktoberfest pull request](https://ctt.ac/36L1C) on X

<br>
Expand All @@ -177,19 +185,20 @@ Optionally you can [Tweet about making your first Hacktoberfest pull request](ht
## ⚠️ Important Notes Summary

- You can contribute multiple animations, just create
a new directory with your `<github_username>-<art_name>`
a new directory with your `<github_username>-<art_name>`
- Ensure to have the **3 required files**
- Ensure that you have not modified any other file outside of your own directory
- Ensure that your directory includes an `index.html` and `styles.css`,
these **exact names are important**.
these **exact names are important**.
- Do **NOT** include any **images**, **SVG**'s or **other files**.
Optimized images will be generate automatically
to keep the repository at a manageable size.
Optimized images will be generate automatically
to keep the repository at a manageable size.

For maintenance reasons:

- Keep checking regularly your pull requests to address provided reviews
Reviewers will take time to check PRs, provide reviews and handle all
the repository PRs.
Reviewers will take time to check PRs, provide reviews and handle all
the repository PRs.

- After a while of no activity after a reviewer gave you reviews:
- a label `stale` could be set
Expand Down

0 comments on commit 626d1da

Please sign in to comment.