Skip to content

Commit 342122f

Browse files
Merge pull request learning-zone#29 from ZeroThread/master
[ Feature 🚀 ] Added Contribution guideline.
2 parents c863588 + a821be9 commit 342122f

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Making contributions
2+
3+
You've just gotten on this project and you're as excited as bells, yes?
4+
You'll want to chill a bit and do a bit of understanding guidelines on how you'll make commit messages. I've found commit messages to be very helpful as regards large projects or projects with more than one contributor.
5+
Also always add a new Question to the list of questions instead of updating the exiting one unless there's a typo.
6+
7+
### Let's Contribute 👍
8+
9+
- **Step 1** - Fork this repository.
10+
- **Step 2** - Clone the repository to your local machine.
11+
- **Step 3** - Resolve the bugs, mentions provided in the Issues section of the repository. _Also add a description of what changes you have done_.
12+
- **Step 4** - Add the changes to your repository.
13+
- **Step 5** - Create a PULL Request. And that's all.
14+
15+
### What you can contribute in this repo? 👊
16+
17+
- You can add a new nodejs interview question.
18+
- There are various topics like - Node Process Model , Node Crypto Module, Stubs in Node etc. **_You can contribute in them_**
19+
- You can contribute some **Learning Resources** in the **_Readme.md_** File.
20+
- You can modify previous solutions if you feel like your solution has better **_Time or Space complexity._**
21+
- If you find a typo in the code you can resolve them.
22+
23+
### How to begin
24+
25+
The point of the commit message has to do with a prefix. Commit messages should be in the format:
26+
`[Commit type]: Message(Try to stay within 50 chars)`
27+
28+
Where:
29+
30+
- Commit type: refers to one of a predefined subset of what a commit could mean. The subsets are:
31+
32+
- Feature: Involves adding a new feature to the product or an implementation of a specified feature.
33+
- Chore: For changes that do not add new functionality but simply denotes a task performed. Does not have to do with bug fixes. Changes includes: initializing a new project, addition of files, partial changes that do not cause bugs, updates, etc.
34+
- Bug: For changes fixing a bug, typo or anything that leads to correctness of the system being worked on
35+
- Buggy: Should be avoided as much as possible but could be needed. It is used when changes have been partially implemented and execution of the current state of the project would lead to evil bugs and sinister errors. An example refers to unclosed tags and a hurried commit since you might not get access to your PC for a while. Projects with this commit type as the latest one should perhaps not be pulled or cloned except such implementation is to be continued by you.
36+
37+
- Message: refers to a message describing the changes made. It is important that each commit should only reflect one feature or implementation change. You should not cram two functionalities into one commit except they depend closely on one another. For example, implmentation of auth and adding views for a user profile are closely related but do not inter-depend on one another and should be separated into different commits. This is just to ensure a dev could work with states that are narrowed down to specific implementations and features.
38+
39+
## FAQ
40+
41+
- Must I do this: Yes
42+
- Why: Read up
43+
- What happens if I don't do it: Your pull request wont be merged to master branch.
44+
- Is this the best implementation there is: Nah, I don't think so. It is subject to review and subsequent update. For now, do this.
45+
- Has it worked so far: YEAH, I think so
46+
- What else: Nothing
47+
48+
### Got issues?
49+
50+
Raise an issue
51+
52+
### Friend's not got issues?
53+
54+
Cool still raise the issue.
55+
56+
##### Let's Contribute 🤗

0 commit comments

Comments
 (0)