CookBook - Hacktoberfest

Find the book you want to read next!

PRESENTED BY

What is CookBook?

A cookbook in the programming context is collection of tiny programs that each demonstrate a particular programming concept. The Cookbook Method is the process of learning a programming language by building up a repository of small programs that implement specific programming concepts.

How to contribute?

Here it does not matters, whether you are a beginner or an expert. Grab your coffee mug, take a sip and start your Hacktoberfest journey with us!!

We have got all domains for you. Your all valid contribution will be joyfully welcomed whether you are a developer or a competitive programmer. All you have to do is to pick a topic that is not added to the repository, study it, and then demonstrate the information in a Markup Documentation file as you usually see in the official docs or websites like GFG, Javapoint, etc.

These things should be there in your contribution

Create a folder in the respective domain you want to contribute. The folder will be named after the topic on which you will be writing. Create a Markup Documentation file there and mention the following in that file:

• About the topic
• About all properties related to topic
• Link to official docs of that topic
• Important facts related to that topic (for eg. some default properties)
• Sample code
• Output of the sample code
• Resources

Keep in mind

There should be precise information as we are not judging you on the basis of an essay competition. It should be easy to understand for anyone. You should go through multiple sources of information and study them well before submitting.

⚠️ ⚠️ ⚠️
Remember that:- All your contributions before 31st October will only be fruitful in gaining you hacktoberfest swags.
So what are you waiting for? Start contributing now !!!

Getting Started

Below are the steps to follow to contribute to this project:

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/<your_user_name>/CookBook-Hacktoberfest.git

where your_user_name is your GitHub username.

3. Navigate to the project directory.

cd CookBook-Hacktoberfest

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/GDSC-NITH/CookBook-Hacktoberfest.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your main branch to keep it at par with the main project(updated repository). Feel free to raise new issues.

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Make necessary changes and commit those changes

9. Track your changes.

git add .

10. Commit your changes .

git commit -m "new changes"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on Compare & pull request. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create pull request.

15. And you are done creating a pull request to this project. Be patient while your PR is reviewed.

Contributors