|
1 | | -# 📝 How to Contribute? |
| 1 | +# 📝 Contribute to AI-Code 🚀 |
2 | 2 |
|
3 | | -Welcome to the **AI-Code** project! Whether you're a seasoned developer or just starting, this guide will help you contribute systematically and effectively. Let's build amazing AI projects together! 🚀 |
4 | | - |
5 | | ---- |
| 3 | +Welcome to **AI-Code**! Whether you're an expert or a beginner, your contributions matter. Let's build AI projects together! |
6 | 4 |
|
7 | 5 | ## Getting Started |
8 | 6 |
|
9 | | -### 🌟 Star This Repository |
10 | | - |
11 | | -Show your support by starring the project! 🌟 This helps others discover and contribute. Click [here](https://github.com/Avdhesh-Varshney/AI-Code) to star. |
12 | | - |
13 | | -### 🍴 Fork the Repository |
14 | | - |
15 | | -Create a personal copy of the repository by clicking the **Fork** button at the top right corner of the GitHub page. |
16 | | - |
17 | | -### 📥 Clone Your Forked Repository |
18 | | - |
19 | | -Clone your forked repository to your local machine using: |
20 | | - |
21 | | -```bash |
22 | | -git clone https://github.com/<your-github-username>/AI-Code.git |
23 | | -``` |
24 | | - |
25 | | -### 📂 Navigate to the Project Directory |
26 | | - |
27 | | -Move into the directory where you've cloned the project: |
28 | | - |
29 | | -```bash |
30 | | -cd AI-Code |
31 | | -``` |
32 | | - |
33 | | -### 🌱 Create a New Branch |
34 | | - |
35 | | -Create a separate branch for your changes to keep the `main` branch clean: |
36 | | - |
37 | | -```bash |
38 | | -git checkout -b <your_branch_name> |
39 | | -``` |
40 | | - |
41 | | ---- |
42 | | - |
43 | | -### 🛠️ Set Up the Development Environment |
44 | | - |
45 | | -#### 1. Create a Virtual Environment |
46 | | - |
47 | | -To isolate dependencies, create a virtual environment: |
48 | | - |
49 | | -```bash |
50 | | -python -m venv myenv |
51 | | -``` |
52 | | - |
53 | | -#### 2. Activate the Virtual Environment |
54 | | - |
55 | | -- **Windows:** |
56 | | - ```bash |
57 | | - myenv\Scripts\activate |
58 | | - ``` |
59 | | -- **macOS/Linux:** |
60 | | - ```bash |
61 | | - source myenv/bin/activate |
62 | | - ``` |
63 | | - |
64 | | -#### 3. Install Required Dependencies |
65 | | - |
66 | | -Install all dependencies listed in the `requirements.txt` file: |
67 | | - |
68 | | -```bash |
69 | | -pip install -r requirements.txt |
70 | | -``` |
71 | | - |
72 | | -#### 4. Preview Locally |
73 | | - |
74 | | -Use MkDocs to start the development server and preview the project: |
75 | | - |
76 | | -```bash |
77 | | -mkdocs serve |
78 | | -``` |
79 | | - |
80 | | -Access the site locally at: |
81 | | - |
82 | | -``` |
83 | | -http://127.0.0.1:8000/AI-Code/ |
84 | | -``` |
85 | | - |
86 | | ---- |
| 7 | +1. **Star & Fork:** [Star](https://github.com/Avdhesh-Varshney/AI-Code) ⭐ & fork the repo. |
| 8 | +2. **Clone:** |
| 9 | + ```bash |
| 10 | + git clone https://github.com/<your-github-username>/AI-Code.git && cd AI-Code |
| 11 | + ``` |
| 12 | +3. **Create Branch:** |
| 13 | + ```bash |
| 14 | + git checkout -b <your_branch_name> |
| 15 | + ``` |
| 16 | +4. **Set Up Environment:** |
| 17 | + ```bash |
| 18 | + python -m venv env && source env/bin/activate # (Windows: env\Scripts\activate) |
| 19 | + pip install -r requirements.txt |
| 20 | + ``` |
| 21 | +5. **Preview Locally:** |
| 22 | + ```bash |
| 23 | + mkdocs serve # Visit http://127.0.0.1:8000/AI-Code/ |
| 24 | + ``` |
87 | 25 |
|
88 | 26 | ## Making Contributions |
89 | 27 |
|
90 | | -### ✏️ Make Changes |
91 | | - |
92 | | -Make your desired code edits, add features, or improve documentation. Follow the project's coding standards and contribution guidelines for consistency. |
93 | | - |
94 | | -### 💾 Stage and Commit Changes |
95 | | - |
96 | | -#### 1. Stage All Changes: |
97 | | - |
98 | | -```bash |
99 | | -git add . |
100 | | -``` |
101 | | - |
102 | | -#### 2. Commit Changes with a Descriptive Message: |
103 | | - |
104 | | -```bash |
105 | | -git commit -m "<your_commit_message>" |
106 | | -``` |
107 | | - |
108 | | -### 🚀 Push Your Changes |
109 | | - |
110 | | -Push your branch to your forked repository: |
111 | | - |
112 | | -```bash |
113 | | -git push -u origin <your_branch_name> |
114 | | -``` |
115 | | - |
116 | | -### 📝 Create a Pull Request |
117 | | - |
118 | | -1. Navigate to your forked repository on GitHub. |
119 | | -2. Click Pull Requests, then New Pull Request. |
120 | | -3. Select your branch and describe your changes clearly before submitting. |
121 | | - |
122 | | ---- |
| 28 | +1. **Edit Code:** Follow project standards. |
| 29 | +2. **Stage & Commit:** |
| 30 | + ```bash |
| 31 | + git add . && git commit -m "<your_commit_message>" |
| 32 | + ``` |
| 33 | +3. **Push Changes:** |
| 34 | + ```bash |
| 35 | + git push -u origin <your_branch_name> |
| 36 | + ``` |
| 37 | +4. **Create a Pull Request (PR):** |
| 38 | + - Go to GitHub → Open a PR → Provide clear details. |
123 | 39 |
|
124 | 40 | ## Contribution Guidelines |
125 | 41 |
|
126 | | -### 📂 File Naming Conventions |
127 | | - |
128 | | -- Use `kebab-case` for file names (e.g., `ai-code-example`). |
129 | | - |
130 | | -### 📚 Documentation Standards |
131 | | - |
132 | | -- Follow the [PROJECT README TEMPLATE](./project-readme-template.md) and [ALGORITHM README TEMPLATE](./algorithm-readme-template.md). |
133 | | -- Use raw URLs for images and videos rather than direct uploads. |
134 | | - |
135 | | -### 💻 Commit Best Practices |
136 | | - |
137 | | -- Keep commits concise and descriptive. |
138 | | -- Group related changes into a single commit. |
139 | | - |
140 | | -### 🔀 Pull Request Guidelines |
141 | | - |
142 | | -- Do not commit directly to the `main` branch. |
143 | | -- Use the PR Template and provide all requested details. |
144 | | -- Include screenshots, video demonstrations, or work samples for UI/UX changes. |
145 | | - |
146 | | -### 🧑💻 Code Quality Standards |
147 | | - |
148 | | -- Write clean, maintainable, and well-commented code. |
149 | | -- Ensure originality and adherence to project standards. |
150 | | - |
151 | | ---- |
152 | | - |
153 | | -## 📘 Learning Resources |
154 | | - |
155 | | -### 🧑💻 Git & GitHub Basics |
156 | | - |
157 | | -- [Forking a Repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) |
158 | | -- [Cloning a Repository](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) |
159 | | -- [Creating a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) |
160 | | -- [GitHub Learning Lab](https://lab.github.com/githubtraining/introduction-to-github) |
| 42 | +- **File Naming:** Use `kebab-case` (e.g., `ai-model.py`). |
| 43 | +- **Docs:** Follow [README Template](./project-readme-template.md). |
| 44 | +- **Commits:** Keep them concise & meaningful. |
| 45 | +- **PRs:** No direct commits to `main`, use PR templates, and include screenshots if relevant. |
| 46 | +- **Code Quality:** Clean, maintainable & well-commented. |
161 | 47 |
|
162 | | -### 💻 General Programming |
| 48 | +## Resources |
163 | 49 |
|
164 | | -- [Learn Python](https://www.learnpython.org/) |
165 | | -- [MkDocs Documentation](https://www.mkdocs.org/) |
| 50 | +- **Git & GitHub:** [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo), [Clone](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request), [PR Guide](https://opensource.com/article/19/7/create-pull-request-github) |
| 51 | +- **Learn Python:** [LearnPython.org](https://www.learnpython.org/) |
| 52 | +- **MkDocs:** [Documentation](https://www.mkdocs.org/) |
0 commit comments