You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to ***DevsInTech***✨, and thank you for your interest in contributing! After reading this documentation you'll be able to contribute efficiently to our project. **Tip:** Use the Table of Contents to navigate through the document quickly.
3
+
Welcome to **_DevsInTech_**✨, and thank you for your interest in contributing! After reading this documentation you'll be able to contribute efficiently to our project. **Tip:** Use the Table of Contents to navigate through the document quickly.
4
4
5
5
## Table Of Contents
6
6
7
7
-[Resources for new contributors](#resources-for-new-contributors)
8
8
-[How to get started](#how-to-get-started)
9
-
-[Using the Command Line](#using-the-command-line)
10
-
-[Using GitHub Desktop](#using-github-desktop)
9
+
-[Using the Command Line](#using-the-command-line)
10
+
-[Using GitHub Desktop](#using-github-desktop)
11
11
-[How to set up your Development Environment](#how-to-set-up-your-development-environment)
12
12
-[How to Contribute](#how-to-contribute)
13
-
-[How to Raise an Issue](#how-to-raise-an-issue)
14
-
- [How to report a bug](#how-to-report-a-bug)
15
-
- [How to submit a Documentation Issue/Update](#how-to-submit-a-documentation-issueupdate)
16
-
- [How to make a Feature Request](#how-to-make-a-feature-request)
17
-
- [How to make a style change](#how-to-make-a-style-change)
18
-
-[How to Solve an Issue](#how-to-solve-an-issue)
19
-
-[How to Submit Pull Requests](#how-to-submit-pull-requests)
20
-
-[Using Command Line for Pull Requests](#using-command-line-for-pull-requests)
21
-
-[Using GitHub Desktop for Pull Requests](#using-github-desktop-for-pull-requests)
13
+
-[How to Raise an Issue](#how-to-raise-an-issue)
14
+
-[How to report a bug](#how-to-report-a-bug)
15
+
-[How to submit a Documentation Issue/Update](#how-to-submit-a-documentation-issueupdate)
16
+
-[How to make a Feature Request](#how-to-make-a-feature-request)
17
+
-[How to make a style change](#how-to-make-a-style-change)
18
+
-[How to Solve an Issue](#how-to-solve-an-issue)
19
+
-[How to Submit Pull Requests](#how-to-submit-pull-requests)
20
+
-[Using Command Line for Pull Requests](#using-command-line-for-pull-requests)
21
+
-[Using GitHub Desktop for Pull Requests](#using-github-desktop-for-pull-requests)
22
22
-[Code of Conduct](#code-of-conduct)
23
23
-[Community Guidelines](#community-guidelines)
24
24
-[Licensing](#licensing)
25
25
26
-
27
-
28
26
## Resources for new contributors
29
27
30
28
Are you new to open source? or to open source contributions in general? Well, you came to the right place: here are some resources to help you get started contributing to open source.
@@ -44,56 +42,54 @@ It's worth noting that we have a [Code of Conduct](https://github.com/TanmayAdit
44
42
45
43
## What are the tools needed to contribute to this project
46
44
47
-
48
45
Before you start, you must install the necessary tools mentioned below onto your device.
3. Once **GitHub Desktop** opens up, make sure "**To contribute to the parent project**" option is selected and then click on **Continue**
89
87
90
-
91
-
92
-
4. Finally, open the project in your preferred code editor. (**Warning:** To contribute to the project, all code and documentation modifications should be committed to a separate branch rather than **main/master**.)
95
89
90
+
4. Finally, open the project in your preferred code editor. (**Warning:** To contribute to the project, all code and documentation modifications should be committed to a separate branch rather than **main/master**.)
@@ -111,7 +107,7 @@ GitHub issues are a way to track and manage tasks, bugs, and discussions in a pr
111
107
112
108
---
113
109
114
-
*Raising an issue* involves creating a new entry in the repository's issue tracker to report problems, suggest improvements, or start discussions, facilitating collaboration and issue resolution. **Note:** Always look for existing issues that are similar to the one you want to raise. If you find any, please do not raise the same issue again; otherwise, you may continue to raise your issue.
110
+
_Raising an issue_ involves creating a new entry in the repository's issue tracker to report problems, suggest improvements, or start discussions, facilitating collaboration and issue resolution. **Note:** Always look for existing issues that are similar to the one you want to raise. If you find any, please do not raise the same issue again; otherwise, you may continue to raise your issue.
115
111
116
112
You can raise an issue by visiting the issues page and clicking the green **New issue** button.
117
113
@@ -137,7 +133,6 @@ When reporting bugs on GitHub, it is important to include the following informat
137
133
138
134
This helps expedite the identification and resolution of the bug.
139
135
140
-
141
136
### How to submit a Documentation Issue/Update
142
137
143
138
---
@@ -151,7 +146,6 @@ When reporting a documentation issue or update, it is important to provide clear
151
146
- Mention any confusion or misunderstandings caused by the current documentation.
152
147
- Offer any additional context or information that can assist in resolving the issue.
153
148
154
-
155
149
### How to make a Feature Request
156
150
157
151
---
@@ -163,7 +157,6 @@ When submitting a feature request, it is important to provide clear details and
163
157
- Consider including any relevant examples, code snippets, or mock-ups to illustrate your request.
164
158
- Explain how the requested feature aligns with the goals and scope of the project.
165
159
166
-
167
160
### How to make a style change
168
161
169
162
---
@@ -175,26 +168,17 @@ When suggesting a style change on GitHub, it is important to provide clear detai
175
168
- Provide specific examples or comparisons to illustrate the current style and the desired style.
176
169
- Offer any additional context or information that can assist in evaluating and implementing the style change.
177
170
178
-
179
-
180
171
**Note:** If the issue you wish to raise does not fit into one of these categories, create a blank issue.
181
172
182
-
183
-
184
173
### How to solve an Issue
185
174
186
175
---
187
176
188
177
If you'd like to solve an issue, you can browse our list of open issues in the repository or on our issue tracker. Using relevant labels, you can identify issues which you are capable of resolving. Some of these labels are listed below:
189
178
190
-
191
-
192
179
[`GSSoC23`](https://github.com/devs-in-tech/DevsInTech/labels/GSSoC23) - This label is assigned to those who want to work on an issue under GSSoC23
[`Level 2`](https://github.com/devs-in-tech/DevsInTech/labels/Level%202) - 25 Points (Enhancement of Exisiting feature)
200
184
@@ -244,69 +228,54 @@ Make sure to commit following the Conventional Commits Standards. Your commit me
244
228
`description` : A short summary providing additional contextual information about the code changes.
245
229
246
230
Read more about [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
247
-
231
+
248
232
### Using Command Line for Pull Requests
249
233
250
-
251
234
- If you have already forked the project, update your copy before working.
252
-
253
-
```bash
254
-
git remote update
255
-
git checkout <branch-name>
256
-
git rebase upstream/<branch-name>
257
-
258
-
```
259
-
260
-
⚠️ **Warning:** Avoid commting changes in the Main Branch ⚠️
261
-
235
+
236
+
```bash
237
+
git remote update
238
+
git checkout <branch-name>
239
+
git rebase upstream/<branch-name>
240
+
241
+
```
242
+
243
+
⚠️ **Warning:** Avoid commting changes in the Main Branch ⚠️
244
+
262
245
- Create a new branch for your changes:
263
-
264
-
**Note:** Creating a new branch allows for isolated development and avoids merge conflicts while making PRs
265
-
266
-
```bash
267
-
git checkout -b my-branch
268
-
#Utilize the branch name to specify the type of issue you are addressing, whether it's a feature, bug fix, or enhancement.
269
-
270
-
```
271
-
246
+
**Note:** Creating a new branch allows for isolated development and avoids merge conflicts while making PRs
247
+
248
+
```bash
249
+
git checkout -b my-branch
250
+
#Utilize the branch name to specify the type of issue you are addressing, whether it's a feature, bug fix, or enhancement.
251
+
252
+
```
253
+
272
254
- Commit and push your changes to your forked repository:
273
-
274
-
**Note:** A PR should have only one commit. Multiple commits should be squashed. Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should be more descriptive.
275
-
255
+
**Note:** A PR should have only one commit. Multiple commits should be squashed. Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should be more descriptive.
276
256
- Make sure all of your commits are atomic (one feature per commit).
277
-
278
-
```bash
279
-
git add .
280
-
git commit -m "Add my changes"
281
-
git push origin my-branch
282
-
283
-
```
284
-
257
+
258
+
```bash
259
+
git add .
260
+
git commit -m "Add my changes"
261
+
git push origin my-branch
262
+
263
+
```
264
+
285
265
- Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.
- Open your external code editor and connect to the repository. When you're through with your changes, commit and push them to your forked repository.:
297
-
298
-
**Note:** Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should be more descriptive.
**Note:** Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should be more descriptive.
- Click on **Push origin** or press `Ctrl`+`P` or `⌘`+`P` to push your commits to the branch of your repository on Github. Learn more GitHub Desktop keyboard shortcuts [here](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/overview/github-desktop-keyboard-shortcuts).
- Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution or press `Ctrl` + `R` or `⌘` + `R` on the keyboard in GitHub Desktop.
Copy file name to clipboardExpand all lines: README.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,8 @@
26
26
27
27
DevsInTech is a thriving and welcoming community of developers,tech professionals,and enthusiasts who share a common passion for technology. Our mission is to promote diversity and inclusiveness in the open source community by helping individuals with improving their skills and standing out in the tech space.
28
28
29
+
Check out our <ahref="https://devsintech.vercel.app/">website</a> to get started!
30
+
29
31
## What do we provide?✨
30
32
31
33
DevsInTech offers a wide range of resources and opportunities for developers and tech enthusiasts to expand their skills, connect with peers, and advance their careers. Some of the key offerings include:
@@ -36,13 +38,12 @@ DevsInTech offers a wide range of resources and opportunities for developers and
36
38
37
39
**Networking and Community Events:** We facilitate networking through meetups, conferences, and events, fostering connections, idea sharing, collaboration, and professional relationships.
0 commit comments