Skip to content

Commit

Permalink
docs: Update CONTRIBUTION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SLYTHEREN authored Sep 23, 2024
1 parent 3dc226b commit 3879801
Showing 1 changed file with 50 additions and 28 deletions.
78 changes: 50 additions & 28 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# 🌟 Contribution Guide
# 🌟 Welcome to the Weave Game Project!

Hey there! 🙌 Thanks for your interest in participating and contributing to the **Weave Game Project**! Whether you're a seasoned developer or just starting out, we've made this guide to help you get up to speed quickly and contribute effectively. Let’s break it down step by step. 🛠️
Hey there, fellow ALCC members! 🙌
We’re excited that you’re here to help us enhance the **Weave Game Project**. Whether you’re a coding pro or just starting, this guide will help you contribute easily and effectively. Let’s get started! 🛠️

## 📝 Step-by-Step Contribution Guide

Expand All @@ -11,34 +12,44 @@ First things first, fork this repository to your own GitHub account!

### 2. Clone the Forked Repo Locally
Now that you’ve forked the repo, clone it to your local machine.
```bash
git clone https://github.com/YOUR_USERNAME/weave-game.git

- **Using Command Line**:
```bash
git clone https://github.com/YOUR_USERNAME/weave-game.git
```
🔗 New to GitHub? [Check out this video to set up and clone using GitHub Desktop](https://youtu.be/g8lJdYwHraY).
- **Using GitHub Desktop**:
- Open GitHub Desktop.
- Click on "File" > "Clone Repository."
- Select your forked repository and click "Clone."

### 3. Create a Branch
Creating a separate branch is a best practice! This keeps our work organized.

### 3. Create a Branch
Althought this is not necessarily needed and you can work on your own main branch it's a better practice!
We follow a branching workflow for any changes. Create your own branch to work on a new feature or bug fix.
- **Using Command Line**:
```bash
git checkout -b feature-name
git checkout -b feature-name
```
**Example**:
**Example**:
```bash
git checkout -b add-landing-page
git checkout -b add-landing-page
```
- **Using GitHub Desktop**:
- Go to the "Current Branch" menu and select "New Branch."
- Name your branch (e.g., `add-landing-page`).

### 4. Add a Component
For front-end contributions, use the `.jsx` format when creating React components / pages( for this project ). All new components should go in the `src/app/components` folder. Please use PascalCase for naming files and folders.
For front-end contributions, use the `.jsx` format for creating React components/pages. New components should go in the `src/app/components` folder. Use PascalCase for naming files and folders.

**Example file name**:
**Example file name**:
LandingPage.jsx

**Folder structure**:
**Folder structure**:
src/app/components/LandingPage/LandingPage.jsx

📚 [Learn more about JSX here](https://reactjs.org/docs/introducing-jsx.html).

### 5. Use Tailwind CSS for Styling
We use Tailwind CSS for all our styling. You can easily add classes to your JSX components like so:
We use Tailwind CSS for styling. You can add classes to your JSX components like this:

```jsx
<div className="bg-blue-500 text-white p-4">
Expand All @@ -47,32 +58,43 @@ We use Tailwind CSS for all our styling. You can easily add classes to your JSX
```
### 6. Commit Your Changes
After making your changes, stage and commit them.
```bash
git add .

- **Using Command Line**:
```bash
git add .
```
```bash
git commit -m "Add Landing Page component"
git commit -m "Add Landing Page component"
```

- **Using GitHub Desktop**:
- Click on "Changes" in the left sidebar.
- Add a summary of your changes and click "Commit to [branch name]."

### 7. Push Your Changes
Push your changes to your forked repository:

- **Using Command Line**:
```bash
git push origin feature-name
git push origin feature-name
```
- **Using GitHub Desktop**:
- Click on "Push origin" in the top right corner.

### 8. Create a Pull Request (PR)
Head over to GitHub and submit a Pull Request from your branch.
Make sure to provide a clear description of your changes!
Submit a Pull Request from your branch. Provide a clear description of your changes!

🔗 Not sure how? [Check this tutorial on how to create a pull request](https://docs.github.com/en/pull-requests).

## 🔄 Naming Convention
- Files and folders should follow **PascalCase**.
- Example: `LandingPage.jsx`
- Use **PascalCase** for files and folders.
- Example: LandingPage.jsx
- Keep components modular and reusable.
- Place components in the `src/app/components` folder.

## 🎨 Styling
- All styling should be done using **Tailwind CSS**.
- Follow the design system in place. Refer to existing components for consistency.
- All styling should use **Tailwind CSS**.
- Follow the design system. Refer to existing components for consistency.

## 🛠️ Tech Stack
- **React** (.jsx format)
Expand All @@ -82,9 +104,9 @@ Make sure to provide a clear description of your changes!
- **Auth.js**

## 🤝 Contributing Etiquette
- Be kind and respectful in your contributions and interactions.
- Be kind and respectful in your contributions.
- Ensure your code is clean and well-commented.
- Test your components before submitting.
- Collaborate with other members / contributors to avoid duplicate work.
- Collaborate with other members to avoid duplicate work.

That’s it! 🎉 Now you’re all set to contribute to the **Weave Game Project**! We look forward to your awesome contributions. 🚀 Happy coding! 😎
That’s it! 🎉 Now you’re all set to contribute to the **Weave Game Project**! We can’t wait to see what you create. 🚀 Happy coding! 😎

0 comments on commit 3879801

Please sign in to comment.