CoderChef Kitchen 🍰 🍭🍦🍩

The aim of CoderChef Kitchen is to be a one-stop shop for programmers, both experienced and amateurs alike to brush up and hone their programming skills. The repository contains well documented mini-blogs for a vast variety of programming problems.

• 🔥 Programming problems from some of the best online judges like Leetcode.com, Codechef.com etc.
• 🎉 Each problem has an intuition section, followed by the algorithm and the pseudo-code, and finally the implementation. Additionally, the problems are embellished with explanatory images and animations to provide clarity of thought.
• ✏️ For now, we only add solutions in Python for the questions. Contributions are always welcome for solutions in other programming languages.

How to Contribute ?

When people start off with their programming journey, they usually come across algorithms like Linear Search, Bubble Sort, Insertion Sort and much more. There are a bazillion resources out there for such introductory algorithms.

Our aim with CoderChef Kitchen (Don't miss that 'r' 😅) is not to add articles just for the sake of it. Our main intention is to add articles that bring across some important programming concepts or some new algorithmic techniques or some interesting implementation ideas that we don't generally find online.

In addition to this, we want to make programming fun for people out there. We want to break away from the common notion of "tech articles are boring and serious". They can be pretty fun and addictive to read, if projected in a certain way.

There are multiple ways in which you can contribute. There are no "prerequisites" as such for you to become a contributor. Essentially, you can do either of the following:

1. Pick up one of the existing problems from the repository and add a solution in a language not already present in the repo. For e.g. a lot of problems currently only have solutions in Python. It would be great to have solutions in other common languages like Java or C/C++.

   An important thing to consider here is that the solution you provide must be in line with the algorithm(s) already explained in the article. In case you are writing a new algorithm which has not been explained already, then make sure to add relevant explanation to the article as well.

2. The second way for you to contribute is by picking a problem which is not already there in the repository and contribute solution(s) and an article for it.

   A picture is worth a thousand words

   That is our motto. The articles that we write tend to be full of illustrations in the form of explanatory diagrams and gifs/videos/animations. Anything that helps explain the algorithm better. We would love future articles to be along the same lines as well. For a detailed set of guidelines for contributing a new article, read the instructions below.

   

Contribution Guideline

1. The first thing you should do is, convey what you want to contribute. To make it a very streamlined process, create an issue in the repository describing the problem you want to pick. Also, in 1-2 lines explain why you think this problem should be added to the repo.

   Kindly note this step is only to be sure that your efforts won't go to waste. Once the issue is approved, you can go ahead with article. This still doesn't guarantee that your article would be accepted on the first go. Our only suggestion is stick to the template (read below) and be as creative as possible. We are always there to help and learn in the process.

2. Clone the repo using the command

   git clone https://github.com/DivyaGodayal/CoderChef-Kitchen.git
   

3. For every new problem, create a separate folder in the respective section. For e.g. if you are solving a problem on LeetCode related to Dynamic Programming, create a folder for the problem under the Dynamic Programming folder.

   mkdir Dynamic-Programming/<Problem Name>
   

4. The newly created folder must contain a README.md file and solution.py file. If there are multiple solutions, you can name the solutions accordingly. e.g. solution_min_heap.py or solution_recursive.py.

   touch README.md
   touch solution.py
   

5. For writing the README.md file, follow the template provided here.

6. Ideally, every approach to a programming problem should have the following sections:

   1. Motivation.
   2. Algorithm.
   3. Implementation Details. (Optional)
   4. Complexity Analysis.

7. Once you are done writing the article and the solutions, remember to add the problem to the table on the main README page. (Look at the table of contents below).

8. Once all your changes are done, create a local commit.

   git add .
   git commit -am "Added article and solution for <Problem-Name>"
   

9. Push your changes to a separate branch for the problem. This new branch should be deleted once the PR is merged.

   git push origin master:<branch_name>
   

10. Raise a Pull Request. This step is very important. For any changes you want to make to the repository, you have to raise a pull request. For further reading on how to raise a PR, read this.

11. In case of any doubt in the above steps, reach out to us. :)