Skip to content

Commit b57f55d

Browse files
sumitbishtisumitbishti
committed
added documentation
1 parent 0c29352 commit b57f55d

File tree

2 files changed

+364
-0
lines changed

2 files changed

+364
-0
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.0, available at
118+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
120+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121+
enforcement ladder](https://github.com/mozilla/diversity).
122+
123+
[homepage]: https://www.contributor-covenant.org
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
https://www.contributor-covenant.org/faq. Translations are available at
127+
https://www.contributor-covenant.org/translations.

‎Contributing_Guidelines.md

Lines changed: 237 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,237 @@
1+
<!-- omit in toc -->
2+
3+
# Contributing to Dev-Geeks
4+
5+
First off, thanks for taking the time to contribute! ❤️
6+
7+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
8+
9+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
10+
>
11+
> - Star the project
12+
> - Tweet about it
13+
> - Refer this project in your project's readme
14+
> - Mention the project at local meetups and tell your friends/colleagues
15+
16+
<!-- omit in toc -->
17+
18+
## Table of Contents
19+
20+
- [I Have a Question](#i-have-a-question)
21+
- [I Want To Contribute](#i-want-to-contribute)
22+
- [Reporting Bugs](#reporting-bugs)
23+
- [Suggesting Enhancements](#suggesting-enhancements)
24+
- [Your First Code Contribution](#your-first-code-contribution)
25+
- [Improving The Documentation](#improving-the-documentation)
26+
- [Styleguides](#styleguides)
27+
- [Commit Messages](#commit-messages)
28+
29+
## I Have a Question
30+
31+
> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/pranjay-poddar/Dev-Geeks/blob/main/README.md).
32+
> Before you ask a question, it is best to search for existing [Issues](https://github.com/pranjay-poddar/Dev-Geeks/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
33+
34+
If you then still feel the need to ask a question and need clarification, we recommend the following:
35+
36+
- Open an [Issue](https://github.com/pranjay-poddar/Dev-Geeks/issues/new).
37+
- Provide as much context as you can about what you're running into.
38+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
39+
40+
We will then take care of the issue as soon as possible.
41+
42+
<!--
43+
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
44+
Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
45+
- IRC
46+
- Slack
47+
- Gitter
48+
- Stack Overflow tag
49+
- Blog
50+
- FAQ
51+
- Roadmap
52+
- E-Mail List
53+
- Forum
54+
-->
55+
56+
## Basics of Git and GitHub
57+
58+
### Git & GitHub
59+
60+
Before we proceed, it's better to know the difference between Git and Github. Git is a version control system (VCS) that allows us to keep track of the history of our source code , whereas GitHub is a service that hosts Git projects.
61+
62+
We assume you have created an account on Github and installed Git on your System.
63+
64+
Now enter your name and E-mail (used on Github) address in Git, by using following command.
65+
66+
`$ git config --global user.name "YOUR NAME"`
67+
` $ git config --global user.email "YOUR EMAIL ADDRESS"`
68+
This is an important step to mark your commits to your name and email.
69+
70+
<br />
71+
72+
### Fork a project
73+
74+
You can make a copy of the project to your account. This process is called forking a project to your Github account. On Upper right side of project page on Github, you can see -
75+
76+
<p align="center"> <img src="https://i.imgur.com/P0n6f97.png"> </p>
77+
Click on fork to create a copy of project to your account. This creates a separate copy for you to work on.
78+
79+
<br />
80+
81+
<br />
82+
83+
### Clone the forked project
84+
85+
You have forked the project you want to contribute to your github account. To get this project on your development machine we use clone command of git.
86+
87+
`$ git clone https://github.com/pranjay-poddar/Dev-Geeks.git` <br/>
88+
Now you have the project on your local machine.
89+
90+
<br />
91+
92+
### Add a remote (upstream) to original project repository
93+
94+
Remote means the remote location of project on Github. By cloning, we have a remote called origin which points to your forked repository. Now we will add a remote to the original repository from where we had forked.
95+
96+
`$ cd <your-forked-project-folder>`
97+
`$ git remote add upstream https://github.com/pranjay-poddar/Dev-Geeks.git` <br/>
98+
You will see the benefits of adding remote later.
99+
100+
<br />
101+
102+
### Synchronizing your fork
103+
104+
Open Source projects have a number of contributors who can push code anytime. So it is necessary to make your forked copy equal with the original repository. The remote added above called Upstream helps in this.
105+
106+
`$ git checkout main`
107+
`$ git fetch upstream`
108+
`$ git merge upstream/main`
109+
`$ git push origin main` <br/>
110+
The last command pushes the latest code to your forked repository on Github. The origin is the remote pointing to your forked repository on github.
111+
112+
<br />
113+
114+
### Create a new branch for a feature or bugfix
115+
116+
Usually, all repositories have a main branch that is regarded to be stable, and any new features should be developed on a separate branch before being merged into the main branch. As a result, we should establish a new branch for our feature or bugfix and go to work on the issue.
117+
118+
`$ git checkout -b <feature-branch>`
119+
This will create a new branch out of master branch. Now start working on the problem and commit your changes.
120+
121+
`$ git add --all`
122+
`$ git commit -m "<commit message>"`
123+
The first command adds all the files or you can add specific files by removing -a and adding the file names. The second command gives a message to your changes so you can know in future what changes this commit makes. If you are solving an issue on original repository, you should add the issue number like #35 to your commit message. This will show the reference to commits in the issue.
124+
125+
<br />
126+
127+
### Push code and create a pull request
128+
129+
You now have a new branch containing the modifications you want in the project you forked. Now, push your new branch to your remote github fork.
130+
131+
`$ git push origin <feature-branch>`
132+
Now you are ready to help the project by opening a pull request means you now tell the project managers to add the feature or bug fix to original repository. You can open a pull request by clicking on green icon -
133+
134+
<p align="center"> <img src="https://i.imgur.com/aGaqAD5.png"> </p>
135+
136+
Remember your upstream base branch should be main and source should be your feature branch. Click on create pull request and add a name to your pull request. You can also describe your feature.
137+
138+
Fantastic! You've already made your first contribution.🥳
139+
140+
#### BE OPEN!
141+
142+
#### Happy Coding 👩‍💻👩‍💻
143+
144+
## I Want To Contribute
145+
146+
> ### Legal Notice <!-- omit in toc -->
147+
>
148+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
149+
150+
### Reporting Bugs
151+
152+
<!-- omit in toc -->
153+
154+
#### Before Submitting a Bug Report
155+
156+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
157+
158+
- Make sure that you are using the latest version.
159+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/pranjay-poddar/Dev-Geeks/blob/main/README.md). If you are looking for support, you might want to check [this section](#i-have-a-question)).
160+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the _**bug tracker**_.
161+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
162+
- Collect information about the bug:
163+
- Stack trace (Traceback)
164+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
165+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
166+
- Possibly your input and the output
167+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
168+
169+
<!-- omit in toc -->
170+
171+
#### How Do I Submit a Good Bug Report?
172+
173+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to the maintainer.
174+
175+
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
176+
177+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
178+
179+
- Open an [Issue](https://github.com/pranjay-poddar/Dev-Geeks/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
180+
- Explain the behavior you would expect and the actual behavior.
181+
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
182+
- Provide the information you collected in the previous section.
183+
184+
Once it's filed:
185+
186+
- The project team will label the issue accordingly.
187+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
188+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
189+
190+
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
191+
192+
### Suggesting Enhancements
193+
194+
This section guides you through submitting an enhancement suggestion for Dev-Geeks, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
195+
196+
<!-- omit in toc -->
197+
198+
#### Before Submitting an Enhancement
199+
200+
- Make sure that you are using the latest version.
201+
202+
- Read the [documentation](https://github.com/pranjay-poddar/Dev-Geeks/blob/main/README.md) carefully and find out if the functionality is already covered, maybe by an individual configuration.
203+
- Perform a [search](https://github.com/pranjay-poddar/Dev-Geeks/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
204+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
205+
206+
<!-- omit in toc -->
207+
208+
#### How Do I Submit a Good Enhancement Suggestion?
209+
210+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/pranjay-poddar/Dev-Geeks/issues).
211+
212+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
213+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
214+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
215+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
216+
- **Explain why this enhancement would be useful** to most Dev-Geeks users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
217+
218+
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
219+
220+
### Your First Code Contribution
221+
222+
Contributing to open source for the first time can be scary and a little overwhelming. Perhaps you’re a Code Newbie or maybe you’ve been coding for a while but haven’t found a project you felt comfortable contributing to.
223+
224+
If you have never contributed to an open source project before and you’re just getting started, consider exploring these resources.
225+
226+
[First contributions](https://github.com/firstcontributions/first-contributions) is a hands-on tutorial that walks you through contributions workflow on GitHub. When you complete the tutorial, you have made a contribution to the same project.
227+
228+
### Improving The Documentation
229+
230+
If you want to improve the documentation then first go through [Creating Documentation](https://octoverse.github.com/creating-documentation/) website.
231+
232+
## Styleguides
233+
234+
### Commit Messages
235+
236+
Commit Message should reflect the work you have done (resolve bug or add feature).
237+
<a href="#top"><img src="https://img.shields.io/badge/-Back%20to%20Top-red?style=for-the-badge" align="right"/></a>

0 commit comments

Comments
 (0)