A guide to git commits

Things to install :)

• Download VSCode
• Install Hackatime

• Configure Hackatime

  • Run the script here to configure your Wakatime extension to use Hackatime - Hack Club’s time-tracking platform.

  • Once you start coding, make sure you check back on Hackatime to see if your project is there!

• git!!

What is git?

• Lets you save your code changes permanently (not locally)
• Keeps track of your code’s changes over time
• Allows you to collaborate with friends
• Universally used by devs

Lets make a repo!!!

1. Make a folder on your device for your projects

2. Connect your GitHub repo with your local project

3. Open your terminal For example, if your projects folder is in Documents/Projects, type cd Documents/Projects

Then type git clone <linkyoucopied> and press enter

4. Start coding! But before you make any major features, keep reading.

Commits

Saves all your current code Like a snapshot in time (you can go back to see previous versions) Good practice to commit often (1 per hour is recommended) 1 commit = 1 feature, or change

Commit Best Practices

Detailed commits that explain what you fixed or changed e.g “Added info page and search functionality”

• Conventional commits are also pretty cool! e.g “feat: search functionality”

Use whatever works for you – commits are there to help you and others keep track of changes in your code.

What Counts as shipped?

• Project has all code files needed to run
• Project has a detailed README.md (not written by AI)
• Project is deployed/has a link where someone else can try it
• Project has a demo video or screenshot of it in action
• You’re proud of what you made!

Your README should show the following:

• What your project is and where it can be used
• What you made it with
• A demo of your project (image or video works!)
• How other people can contribute to it
• How it can be deployed

The README is the first thing people see when they’re looking at your repository, so it’s important that it looks nice and is informative!

README files are usually in Markdown. Check out the GitHub markdown guide to make your README look good.

Deploying Python projects

If you’ve made a Python project that is not a web project, you can deploy it using Pyinstaller. Some common examples are terminal based projects and projects that open up a GUI e.g Pygame games.

Once you have Pyinstaller installed, run this command in the location of your code file (e.g in the VSCode terminal of your open project)

pyinstaller --onefile nameofyourpythonfilehere.py

This guide was originally written by Phthallo for HCTG.