Skip to content

Home

Jump to bottom
Alexander Konovalov edited this page Apr 10, 2020 · 5 revisions

Welcome to the wedderga wiki!

How to write good commit messages

https://chris.beams.io/posts/git-commit/

How to generate test files

Test files named weddergaXX.tst are generated automatically. Do not edit them! Instead, call gap makedoc.g.

How to contribute

Initial setup

  1. Install Git: we suggest to follow Software Carpentry instructions for your operating system. You can find them at any of the recent workshops teaching Git, for example at https://ccp-codima.github.io/2020-02-20-lancaster/#setup

  2. Set up Git: we suggest to follow instructions from the Software Carpentry lesson on Git at https://swcarpentry.github.io/git-novice/02-setup/index.html. You need to specify your name and email address to sign your commit messages, specify how to handle line endings to avoid mixing Windows and UNIX style line ending in the code, and set up an editor to compose commit messages (we recommend to use nano).

  3. Clone this repository: Decide in which directory you will keep the clone of this repository. Navigate to that directory in the terminal, and then call

   git clone https://github.com/gap-packages/wedderga.git

Remark: One of approaches could be to put the clone into ~/.gap/pkg/ directory (On Windows, _gap\pkg in your home directory). This way, it will be loadable by any version of GAP running on your machine, unless you start GAP with -r command line option. Another approach could be to go to the pkg directory your GAP installation, remove the directory with an official Wedderga release, and put a clone there. The latter approach may seem simpler, but your setup will need an upgrade after you install a new GAP release.

  1. Create a free GitHub account at https://github.com/join and log in into GitHub at https://github.com/login

  2. Fork of this repository, as explained at https://help.github.com/en/github/getting-started-with-github/fork-a-repo. We will assume that the URL of your fork will be https://github.com/your-username/wedderga.git, where your-username is the name of your GitHub account.

  3. Configure remote repositories for your clone: navigate to the directory with the clone of this repository and call git remote -v. You should see the following:

$ git remote -v
origin	https://github.com/gap-packages/wedderga.git (fetch)
origin	https://github.com/gap-packages/wedderga.git (push)

Call git remote add your-username https://github.com/your-username/wedderga.git (replace your-username by your actual GitHub username twice). Now call git remote -v again; you should see an output like this:

$ git remote -v
origin	git@github.com:gap-packages/wedderga.git (fetch)
origin	git@github.com:gap-packages/wedderga.git (push)
your-username	https://github.com/your-username/wedderga.git (fetch)
your-username	https://github.com/your-username/wedderga.git (push)

which means that now your repository "knows" two remotes; the main one having an alias "origin", and your fork, having an alias "your-username" (you can use a different alias, e.g. "myfork" if you wish; an alias coinciding with a username makes more obvious who is the owner of the remote, especially if you collaborate with multiple remotes). See more about remote repositories at https://swcarpentry.github.io/git-novice/07-github/index.html

Now you should be ready to propose changes.

  1. Checkout appropriate branch

  2. Create a new branch

  3. Make changes

10 Push them into your fork

11 Submit PR via GitHub web interface

12 If you need to update: amend commit and force push

Clone this wiki locally