The main documentation repository for the 🍭☁️
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

7.2 KiB

Gitea cheat sheet for beginners and the forgetful

Below is the basic Gitea workflow, to help you with your contributions. But do not hesitate to reach out to any of the organizers for help! We’re happy to walk you through any or all of this, no matter what your experience level. If you’ve never even heard of Gitea before, we’d love to help you submit your first contribution!

This document gets wordy because Git is not as welcoming to beginners as we wish it was, but you can do it! And you’re not alone! We are just a message or comment away. There are even more resources in the Bibliography at the end, if you want to dive deeper. You may even want to skip this document entirely at first, and see if Your First Pull Request more suited to your needs.

If you need more Git, check out the Git Book.

Basic Steps For Contributing

These are the general steps, but if you need more information, keep reading.

  • Fork the repository (just once) from Lollipop Cloud project page
  • Clone your fork on your own computer (just once)
  • Create a branch for your changes
  • Edit, make changes and contributions
  • Push those changes to your branch
  • Open a merge/pull request in Gitea
  • Wait for project coordinator to provide feedback or approve the merge/pull request

And now... what to do if you’ve never done this before

Log in to Gitea

If you haven’t already, create an account on the Lollipop Cloud project page and log in.

Fork it! (copy the project to your Gitea account)

View the repository you would like to work on (docs or website), and click Fork in the upper right corner. You will only have to fork once!

A fork is an exact copy of the project as it existed at the exact moment you forked it. So when the project updates in the future, you will have to update your code too, but we will talk about that later.

At this point, you will need a command line client like PuTTY for Windows users, or the built-in Terminal for MacOS users.

Go to (or create) a directory where you’d like your copy of the project to live, and open it.

In PuTTY or Terminal, enter each of the following commands, where “lollipop_project” is the name of directory where you would like to store the clone.

mkdir /path/to/lollipop_project

cd /path/to/lollipop_project

Clone (create a local copy) of the project files

View your newly created fork in your web browser and copy the https:// address in the box on the right side of the page. In your terminal program, enter git clone, with the correct URL. You are downloading all the project files to your computer! Good work!

View your cloned project on your computer

Git will install the project in a new folder. Use the command ls to see the name of the new project folder if you are unsure. Open this new folder with cd cloned_directory_name to see what was installed.

Add the upstream path

(Do this step only once!)

Over time, you will want to keep your local clone of your fork updated with changes made to the original repo. To make this easier, define a “remote” repository in your local clone, called upstream, that points to the original repo.

From your cloned_directory_name directory, do this:

git remote add upstream (with the original repository URL).

Create a branch

The git checkout command at the end will create a branch, but this is a good practice for each time you want to create a new branch for contributing:

git checkout master

git fetch upstream

git rebase upstream/master

git checkout -b new_branch_name

Now the changes you make will be associated with new_branch_name.

Edit your contributions

Now that the files live locally on your computer, and you have a branch set up for your new contributions, you can edit the files with your favorite editor. Stick with the command line (Vim, Emacs, Nano), or use a text editor like Atom. Be sure to save your changes.

Add your changed files to git, to prepare them for uploading

If you added new files to the project, in your terminal you will have to git add edited-file-name for each of those new files.

Commit your changes

When you’re ready, go back to the command line and commit your changes with a short but descriptive comment. git commit -m "Updated List of Anthropomorphic Potatoes"

Push your changes to the branch in your fork

When you’re really ready, “push” those changes to the original source, which is a request to accept and merge your contributions with the rest of the project. Note: A push request and a merge request are the same thing. git push -u origin new_branch_name

Create a pull request (AKA merge request)

Go back to your browser and your forked repository and go to Pull Requests and choose New Pull Request.

There will be two drop-down menus that will probably say base: master and compare: master. The “base” fork is the original project, NOT your forked version. Under the compare menu, choose your new_branch_name. Enter a short title for the changes, a description to help reviewers understand your contributions, and click the big Submit Pull Request button below your text.

Congratulations! You’ve submitted your first pull request! 🎉

The developers will review your changes and work with you on next steps.


What to do when “upstream” changes...

“Upstream” is the name of the original code (not your fork). When it gets updated after you clone or fork, you will have to request a copy of those changes to stay up-to-date.

Fetch the changes since you first forked or last fetched changes

In order to be sure you’re working off the latest copy of the project, you can fetch the latest changes with git fetch upstream. (Note: this can only be done at the command line, not the user interface/URL.)

Now you have the latest copy of the project in your local directory. Your new changes from this point forward will be stored in a local branch called upstream/master.

Make your edits! Then you can go back to the section [about adding your changed files to git](#Add your changed files to git, to prepare them for uploading).