Pilgrimage Menu Updates Participate! Project To do

Introduction

The purpose of this page is to help new contributors getting started with git. We shall introduce the main commands that are typically used during a regular workflow.

Official git resources

The official git documentation is clear and extensive.

• Git homepage, official website.
• Git documentation.

The following sections of the official documentation may be particularly useful:

• 2.5 Git Basics - Working with Remotes
• 3.5 Git Branching - Remote Branches

Before submitting a pull request you must be aware of the following conditions and agree with them:

1. Do not submit third-party copyrighted material.
2. Unless agreed otherwise, the content of your pull request will enter the public domain upon being committed into the main repository.
3. Read and agree with the content of the LICENSE.md file.
4. Read and agree with the copyright page.

Getting started

Create an account at Codeberg. In the examples below, we shall use the name "Theo" as the account name. Replace it with your own account name.

• Official Codeberg documentation: Pull requests and Git flow.

Go to the official repository and click the "Fork" icon in the top right corner.

The following steps are to be performed in a console environment (either "konsole" or equivalent in Linux, or within the Windows console). The dollar sign "$" represents the console prompt (it could be the sign > on some systems, e.g. Windows).

Clone your own repository (the fork you just created). Use your own account name in place of "Theo":

$ git clone https://codeberg.org/Theo/PilgrimageForDemocracy.git --origin theo

Change to the code directory:

$ cd PilgrimageForDemocracy

Add the official repository:

$ git remote add pilgrim https://codeberg.org/DemocracyPilgrim/PilgrimageForDemocracy.git

See that you have the remotes properly configured:

$ git remote --verbose theo https://codeberg.org/Theo/PilgrimageForDemocracy.git (fetch) theo https://codeberg.org/Theo/PilgrimageForDemocracy.git (push) pilgrim https://codeberg.org/DemocracyPilgrim/PilgrimageForDemocracy.git (fetch) pilgrim https://codeberg.org/DemocracyPilgrim/PilgrimageForDemocracy.git (push)

Fetch all the code from the official repository:

$ git fetch pilgrim

Check all existing branches. The default local branch should be 'master'. All available remote branches are listed as well:

$ git branch --all * master remotes/theo/HEAD -> theo/master remotes/theo/master remotes/pilgrim/master

Before editing, it is better to create a new branch for each piece of content you would like to contribute. Use a meaningful name for your branch, instead of the example given: 'my-contribution'.

$ git checkout -b my-contribution

After having made the edits you wanted and committed them locally, you may push them to your public repository:

$ git push --set-upstream theo my-contribution

Remember to continuously rebase your repository with the upstream official repository. Do so daily or whenever you start working on the project.

$ git pull --rebase pilgrim master

Pilgrimage Menu Updates Participate! Copyright? Project To do