@@ -5,43 +5,49 @@ Thanks for showing interest in contributing to **Inquizzitive**! 💡 We welcome
55## 📌 How to Contribute
66
77### 1. Check Issues
8- * Look at the ** Issues** tab of this repository.
9- * Pick any issue labeled ` hacktoberfest ` , ` good first issue ` , or ` enhancement ` .
10- * You can also propose your own improvements by creating a new issue.
8+
9+ - Look at the ** Issues** tab of this repository.
10+ - Pick any issue labeled ` hacktoberfest ` , ` good first issue ` , or ` enhancement ` .
11+ - You can also propose your own improvements by creating a new issue.
1112
1213### 2. Fork the Repository
13- * Click the ** Fork** button at the top right of this repo.
14- * Clone your fork locally:
14+
15+ - Click the ** Fork** button at the top right of this repo.
16+ - Clone your fork locally:
1517
1618``` bash
1719git clone git@github-sbdecoder:sb-decoder/inquizzitive.git
1820cd inquizzitive
1921```
2022
2123### 3. Create a New Branch
22- * Always create a separate branch for your work:
24+
25+ - Always create a separate branch for your work:
2326
2427``` bash
2528git checkout -b feature/your-feature-name
2629```
2730
2831### 4. Set Up Environment Variables
29- * If the project uses the Gemini API, you'll need to get an API key:
30- * Visit [ Google AI Studio] ( https://aistudio.google.com/app/apikey )
31- * Sign in with your Google account
32- * Click on ** "Get API Key"** or ** "Create API Key"**
33- * Copy your API key and add it to your ` .env ` file:
32+
33+ - If the project uses the Gemini API, you'll need to get an API key:
34+ - Visit [ Google AI Studio] ( https://aistudio.google.com/app/apikey )
35+ - Sign in with your Google account
36+ - Click on ** "Get API Key"** or ** "Create API Key"**
37+ - Copy your API key and add it to your ` .env ` file:
3438 ``` bash
3539 GEMINI_API_KEY=your_api_key_here
3640 ```
37- * Make sure to ** never commit your ` .env` file** to the repository.
41+ - Make sure to ** never commit your ` .env` file** to the repository.
3842
3943# ## 5. Test Your Changes
40- * Work on code, UI, docs, or any improvement.
41- * If you are fixing a bug or issue, ** reference the issue number** in your commit message.
44+
45+ - Work on code, UI, docs, or any improvement.
46+ - If you are fixing a bug or issue, ** reference the issue number** in your commit message.
4247
4348# ## 6. Test Your Changes Locally
44- * Make sure the project runs without errors:
49+
50+ - Make sure the project runs without errors:
4551
4652` ` ` bash
4753npm install
@@ -51,8 +57,11 @@ npm run server
5157` ` `
5258
5359# ## 7. Test Your Changes in Production environment
54- * Make sure the project runs without errors:
55- - Note: It will automatically stops
60+
61+ - Make sure the project runs without errors:
62+
63+ * Note: It will automatically stops
64+
5665` ` ` bash
5766npm install
5867npm run start
@@ -68,37 +77,38 @@ git push origin feature/your-feature-name
6877` ` `
6978
7079# ## 9. Open a Pull Request
71- * Go to your fork on GitHub.
72- * You' ll see a **Compare & Pull Request** button. Click it.
73- * Provide details about what you changed and why.
74- * Wait for review and feedback.
80+
81+ - Go to your fork on GitHub.
82+ - You' ll see a **Compare & Pull Request** button. Click it.
83+ - Provide details about what you changed and why.
84+ - Wait for review and feedback.
7585
7686## ✅ Contribution Guidelines
7787
78- * Write **clear commit messages**.
79- * Keep PRs **small and focused** on one feature/fix.
80- * Follow project' s coding style (React + CSS).
81- * Update documentation if your change requires it.
82- * Be respectful and collaborative with maintainers and other contributors.
88+ - Write **clear commit messages**.
89+ - Keep PRs **small and focused** on one feature/fix.
90+ - Follow project' s coding style (React + CSS).
91+ - Update documentation if your change requires it.
92+ - Be respectful and collaborative with maintainers and other contributors.
8393
8494# # 💡 What You Can Work On
8595
86- * Fix open issues in the repository.
87- * Improve UI/UX (Glassmorphism, navbar, homepage, etc.).
88- * Add more quiz categories or difficulty levels.
89- * Write better documentation.
90- * Improve performance or code readability.
96+ - Fix open issues in the repository.
97+ - Improve UI/UX (Glassmorphism, navbar, homepage, etc.).
98+ - Add more quiz categories or difficulty levels.
99+ - Write better documentation.
100+ - Improve performance or code readability.
91101
92102# # 🎯 Hacktoberfest Notes
93103
94- * Make ** quality contributions** . Spam PRs will be marked as ** invalid** 🚫.
95- * Each accepted PR counts toward your Hacktoberfest goals.
96- * Don' t hesitate to ask for clarifications in issues before starting work.
104+ - Make ** quality contributions** . Spam PRs will be marked as ** invalid** 🚫.
105+ - Each accepted PR counts toward your Hacktoberfest goals.
106+ - Don' t hesitate to ask for clarifications in issues before starting work.
97107
98108## 🙌 Need Help?
99109
100- * Open a discussion or ask in issues.
101- * Maintainers will be happy to help you get started.
110+ - Open a discussion or ask in issues.
111+ - Maintainers will be happy to help you get started.
102112
103113---
104114
0 commit comments