Skip to content
This repository was archived by the owner on Mar 2, 2025. It is now read-only.

Commit 33f1fb7

Browse files
Create CONTRIBUTING.md
1 parent 295c855 commit 33f1fb7

File tree

1 file changed

+107
-0
lines changed

1 file changed

+107
-0
lines changed

CONTRIBUTING.md

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Contributing to UberCoders
2+
3+
Thank you for considering contributing to **UberCoders**! We're excited to have you help us grow and improve this project. Whether you're here to report a bug, suggest a feature, or submit a pull request, your contributions are highly appreciated.
4+
5+
---
6+
7+
## Table of Contents
8+
9+
1. [Code of Conduct](#code-of-conduct)
10+
2. [How to Contribute](#how-to-contribute)
11+
- [Reporting Bugs](#reporting-bugs)
12+
- [Suggesting Features](#suggesting-features)
13+
- [Code Contributions](#code-contributions)
14+
3. [Development Setup](#development-setup)
15+
4. [Pull Request Guidelines](#pull-request-guidelines)
16+
5. [Getting Help](#getting-help)
17+
18+
---
19+
20+
## Code of Conduct
21+
22+
Please adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions. Respect, collaboration, and inclusivity are the foundation of this community.
23+
24+
---
25+
26+
## How to Contribute
27+
28+
### Reporting Bugs
29+
If you find a bug, please help us by reporting it:
30+
1. **Check existing issues** to ensure the bug hasn’t been reported yet.
31+
2. Open a [new issue](https://github.com/thedipankarroy/ubercoder/issues) and include:
32+
- A clear title and description of the problem.
33+
- Steps to reproduce the bug.
34+
- Expected vs. actual behavior.
35+
- Relevant screenshots or logs (if applicable).
36+
37+
### Suggesting Features
38+
We’re always looking for great ideas! To suggest a feature:
39+
1. **Check existing issues** to ensure your idea hasn’t been proposed already.
40+
2. Open a [feature request issue](https://github.com/thedipankarroy/ubercoder/issues) and include:
41+
- A detailed explanation of your feature.
42+
- The problem it solves or the benefit it provides.
43+
- Any additional context or resources (e.g., references, mockups).
44+
45+
### Code Contributions
46+
We welcome contributions of code for bug fixes, new features, or improvements. Follow the steps below to get started.
47+
48+
---
49+
50+
## Development Setup
51+
52+
### Prerequisites
53+
Before contributing, ensure you have:
54+
- [Git](https://git-scm.com/) installed.
55+
- Access to the [repository](https://github.com/thedipankarroy/ubercoder).
56+
57+
### Steps
58+
1. Fork the repository.
59+
2. Clone your fork locally:
60+
```bash
61+
git clone https://github.com/your-username/ubercoder
62+
```
63+
3. Navigate to the project directory:
64+
```bash
65+
cd ubercoder
66+
```
67+
4. Create a new branch for your work:
68+
```bash
69+
git checkout -b feature/your-feature-name
70+
```
71+
5. Make your changes and test them thoroughly.
72+
73+
---
74+
75+
## Pull Request Guidelines
76+
77+
### Submitting a Pull Request (PR)
78+
1. Ensure your changes are on a separate branch (not `main` or `master`).
79+
2. Push your branch to your fork:
80+
```bash
81+
git push origin feature/your-feature-name
82+
```
83+
3. Open a PR on the original repository:
84+
- Go to [Pull Requests](https://github.com/thedipankarroy/ubercoder/pulls).
85+
- Click **New Pull Request** and select your branch.
86+
4. Fill out the PR template with:
87+
- A clear description of the changes.
88+
- Reference to related issues (e.g., "Fixes #123").
89+
- Any additional notes or context.
90+
91+
### Guidelines
92+
- Follow the coding style used in the project.
93+
- Write clear, concise commit messages.
94+
- Include tests for your changes, if applicable.
95+
- Ensure your changes do not break existing functionality.
96+
97+
---
98+
99+
## Getting Help
100+
101+
If you need help at any stage:
102+
- Open a [discussion](https://github.com/thedipankarroy/ubercoder/discussions) for general questions.
103+
- Reach out in the UberCoders community channels [UberCoders WhatsApp Group](https://chat.whatsapp.com/Egzobar83QXIfqk1T2eAyI).
104+
105+
---
106+
107+
We’re thrilled to have you contributing to UberCoders! Together, let’s make this project great.

0 commit comments

Comments
 (0)