Skip to content

Commit ea43319

Browse files
abhishek-nexgen-devabhishek-nexgen-dev
authored
Merge pull request #38 from KenAdams27/feat/signup-api
fix(auth): correct signup route and tighten validation
2 parents bc93691 + ca600f8 commit ea43319

10 files changed

Lines changed: 15106 additions & 130 deletions

File tree

‎Contributing.md‎

Lines changed: 69 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -1,179 +1,129 @@
1+
# 📌 CONTRIBUTING.md
12

3+
# Contributing to LocalMind
24

3-
````markdown
4-
# Contributing to LocalMind 🤖
5+
Thank you for your interest in contributing to **LocalMind**!
6+
We welcome all contributions — bug fixes, new features, documentation improvements, or even small cleanups.
57

6-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
7-
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
8-
[![React](https://img.shields.io/badge/React-61DAFB?logo=react&logoColor=black)](https://reactjs.org/)
9-
10-
Thank you for your interest in contributing to **LocalMind — AI Without Limits**!
11-
Your contributions — whether code, documentation, bug reports, or feature suggestions — help make LocalMind better, more reliable, and accessible to everyone.
12-
13-
Please read this guide carefully to ensure smooth collaboration.
8+
Please follow the guidelines below to help us keep the project organized, consistent, and easy for everyone to work with.
149

1510
---
1611

17-
## 🐞 Before You Start – Create an Issue
12+
## 🛠️ How to Contribute
1813

19-
To avoid duplicate work and ensure clarity:
14+
### 1. Fork the Repository
2015

21-
1. **Check existing issues** to see if your idea or bug is already reported.
22-
2. If not, **open a new issue** with:
23-
- A **clear title**
24-
- **Steps to reproduce** (for bugs)
25-
- **Screenshots or references** (if applicable)
26-
3. Wait for maintainers to **review and approve** the issue before starting a PR.
16+
Click the **Fork** button on GitHub to create your own copy of this repository.
2717

28-
> ✅ This keeps contributions organized and ensures efficient collaboration.
18+
### 2. Clone Your Fork
2919

30-
---
3120

32-
## 🛠️ How to Contribute
21+
git clone https://github.com/<your-username>/LocalMind.git
22+
cd LocalMind
3323

34-
1. **Star ⭐ the repository**
35-
2. **Fork 🍴** the repository to your GitHub account
36-
3. **Create a new branch** for each issue or feature
37-
4. Make your changes with **clean and maintainable code**
38-
5. **Push** your branch to your fork
39-
6. Open a **Pull Request (PR)** against the `main` branch of the original repo
4024

41-
---
25+
### 3. Create a New Branch
4226

43-
## 💻 Coding Guidelines
27+
Create a branch that describes your change:
4428

45-
- Follow **TypeScript & React conventions**
46-
- Write **clean, readable code**
47-
- Add **comments** for complex logic
48-
- Use **meaningful commit messages**
49-
- Test your changes locally before submission
5029

51-
---
30+
git checkout -b feature-name
5231

53-
## 🚀 Contribution Workflow
5432

55-
### 1️⃣ Setup Your Local Environment
33+
Examples:
5634

57-
Clone your fork:
35+
* `add-license`
36+
* `fix-path-error`
37+
* `improve-readme`
38+
* `add-ui-component`
5839

59-
```bash
60-
git clone https://github.com/<your-username>/LocalMind.git
61-
cd LocalMind
62-
````
40+
### 4. Make Your Changes
6341

64-
Connect to the upstream (original repository):
42+
* Add or update necessary files.
43+
* Keep code style clean and consistent.
44+
* If adding a feature, include relevant documentation.
6545

66-
```bash
67-
git remote add upstream https://github.com/NexGenStudioDev/LocalMind.git
68-
```
46+
### 5. Commit Your Changes
6947

70-
---
48+
Use meaningful commit messages:
7149

72-
### 2️⃣ Keep Your Fork Updated
7350

74-
Before starting new work, sync your fork:
51+
git add .
52+
git commit -m "Short description of the change"
7553

76-
```bash
77-
git checkout main
78-
git fetch upstream
79-
git merge upstream/main
80-
git push origin main
81-
```
8254

83-
---
55+
**Good examples:**
8456

85-
### 3️⃣ Create a Branch for Your Work
57+
* `Add MIT license`
58+
* `Fix missing environment variable issue`
59+
* `Improve error handling in backend API`
8660

87-
```bash
88-
git checkout -b feature/<short-description>
89-
```
61+
### 6. Push to Your Fork
62+
63+
git push origin feature-name
9064

91-
Examples:
9265

93-
* `feature/add-gemini-support`
94-
* `bugfix/fix-chat-history`
66+
### 7. Open a Pull Request (PR)
9567

96-
> Always create a new branch per issue or feature.
68+
* Go to your fork on GitHub.
69+
* Click **Compare & pull request**.
70+
* Choose base: `main` (original repo)
71+
compare: `feature-name` (your branch)
72+
* Add a clear description of the changes.
9773

9874
---
9975

100-
### 4️⃣ Commit Your Changes
76+
## 🧪 Coding Guidelines
10177

102-
```bash
103-
git add .
104-
git commit -m "Type: Short, descriptive message"
105-
git push origin feature/<short-description>
106-
```
107-
108-
* **Type** can be `Feature`, `Fix`, `Docs`, etc.
109-
* Keep messages concise and descriptive.
78+
* Follow consistent formatting and naming.
79+
* Write clear comments where needed.
80+
* Avoid committing temporary or system-generated files.
81+
* If your change affects functionality, explain the reason in the PR.
11082

11183
---
11284

113-
### 5️⃣ Open a Pull Request (PR)
85+
## 📄 Adding License or Documentation Changes
86+
87+
If you are contributing files such as:
11488

115-
1. Navigate to your fork on GitHub
116-
2. Click **Compare & Pull Request**
117-
3. Target the **main branch** of the original repo
118-
4. Provide a **clear description** of your changes
119-
5. Mention the **issue number** if applicable
89+
* `LICENSE`
90+
* `README.md`
91+
* `CONTRIBUTING.md`
92+
* `CODE_OF_CONDUCT.md`
12093

121-
> Maintainers will review, give feedback, and merge when ready.
94+
Make sure:
95+
96+
* File names follow standard naming.
97+
* Text is clearly formatted in Markdown.
98+
* The PR explains why the document is being added or updated.
12299

123100
---
124101

125-
### 6️⃣ Cleanup After Merge
102+
## 🧵 Keeping Your Fork Updated
103+
104+
Before starting new work, sync your fork:
126105

127-
Update your local main branch:
128106

129-
```bash
130-
git checkout main
131107
git fetch upstream
108+
git checkout main
132109
git merge upstream/main
133110
git push origin main
134-
```
135111

136-
Remove old branches locally:
137-
138-
```bash
139-
git branch -d feature/<short-description>
140-
```
141-
142-
Remove old branches remotely:
143-
144-
```bash
145-
git push origin --delete feature/<short-description>
146-
```
147112

148113
---
149114

150-
## 💡 Best Practices
115+
## ❓ Need Help?
151116

152-
* One branch per issue or feature
153-
* Test all changes before submission
154-
* Use descriptive commit messages
155-
* Avoid pushing directly to `main`
156-
* Provide screenshots, demos, or references for UI changes
157-
158-
---
117+
If you have questions or want guidance:
159118

160-
## 🤝 Contributing Without Code
119+
* Open an **Issue** on GitHub
120+
* Or start a discussion in the repository
161121

162-
Not a developer? You can still help:
163-
164-
* Improve **documentation**
165-
* Suggest **new AI features or models**
166-
* Report **bugs or inconsistencies**
167-
* Add **usage examples or tutorials**
122+
We are happy to help!
168123

169124
---
170125

171-
## ⚙️ Supported Platforms
172-
173-
✅ Works with:
126+
Thank you again for contributing to **LocalMind** ❤️
127+
Your efforts help make this project better for everyone!
174128

175-
* Local & cloud AI models
176-
* Windows, macOS, Linux
177-
* Node.js + React development environment
178-
179-
> LocalMind is open-source, privacy-first, and designed for global collaboration — your contributions make it stronger!
129+
---

0 commit comments

Comments
 (0)