Skip to content

Basics projects for beginners, like Tic-Tac-Toe, snake game etc

Notifications You must be signed in to change notification settings

KrunalKharat02/beginner-projects

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

beginner-projects

  • These are some cool Basic Projects For Beginners in language by folder.
  • This is open source project you can contribute to add beginner friendly projects in respective language
  • To contribute add your beginner friendly projects in the language folder which it is using and if there is no folder for language that is used in your project then add language folder and inside it add your project. project should be of only one file no multiple files!
  • for eg: snake game python project: beginner-projects > PYTHON > snake_game.py

📒 Index

🔰 About

These are some cool Basic Projects For Beginners in language by folder.

⚡ Usage

Can be used by Beginners.

🔌 Installation

  • To install any project just clone it and work on it in its specified language and environment.
$ add installations steps if you have to.

📦 Commands

  • Commands to start the project.

🔧 Development

If you want other people to contribute to this project, this is the section, make sure you always add this.

📓 Pre-Requisites

List all the pre-requisites the system needs to develop this project.

  • A tool
  • B tool

🔩 Development Environment

Write about setting up the working environment for your project.

  • How to download the project...
  • How to install dependencies...

📁 File Structure

Add a file structure here with the basic details about files, below is an example.

.
├── PYTHON
│   ├── snake_game.py
├── C++
├── Ruby
├── Java
├── Contributing.md
└── README.md

🔨 Build

Write the build Instruction here.

🚀 Deployment

Write the deployment instruction here.

🌸 Community

If it's open-source, talk about the community here, ask social media links and other links.

🔥 Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

  1. Report a bug
    If you think you have encountered a bug, and I should know about it, feel free to report it here and I will take care of it.

  2. Request a feature
    You can also request for a feature here, and if it will viable, it will be picked for development.

  3. Create a pull request
    It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.

If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.

🌵 Branches

I use an agile continuous integration methodology, so the version is frequently updated and development is really fast.

  1. stage is the development branch.

  2. master is the production branch.

  3. No other permanent branches should be created in the main repository, you can create feature branches but they should get merged with the master.

Steps to work with feature branch

  1. To start working on a new feature, create a new branch prefixed with feat and followed by feature name. (ie. feat-FEATURE-NAME)
  2. Once you are done with your changes, you can raise PR.

Steps to create a pull request

  1. Make a PR to stage branch.
  2. Comply with the best practices and guidelines e.g. where the PR concerns visual elements it should have an image showing the effect.
  3. It must pass all continuous integration checks and get positive reviews.

After this, changes will be merged.

❗ Guideline

coding guidelines or other things you want people to follow should follow.

❓ FAQ

You can optionally add a FAQ section about the project.

📄 Resources

Add important resources here

📷 Gallery

Pictures of your project.

🌟 Credit/Acknowledgment

Credit the authors here.

🔒 License

Add a license here, or a link to it.