gnu/wget2
1
0
Fork 0
mirror of https://gitlab.com/gnuwget/wget2.git synced 2026-01-14 02:01:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
Page: Contributing guide for new developers
Pages
Building with alternate GnuTLS version Charset encoding decoding Contributing guide for new developers GHM 2019 Libwget GNU vs. non GNU HFS testing on Linux Home Release todo list Speed and CPU measurements The new robots.txt [GSoC 2019] Currently failing tests for h2 continuous integration enhancing gnulib module 'open' to return eisdir regarding posix.2008
Clone
9
Contributing guide for new developers
Tim Rühsen edited this page 2019-12-07 18:16:30 +00:00
Table of Contents

This is a quick-start guide for new developers and not meant to be an exhaustive git/GitLab tutorial, in any way.

General git Setup

You only need to do this once.

Configure your name and email:

  $ git config --global user.name "<Firstname> <Lastname>"
  $ git config --global user.email <youremail@domain.com>

wget2 Setup

You only need to do this once.

  1. Fork the upstream via GitLab interface
  2. Clone your fork:
  $ git clone https://gitlab.com/<your username>/wget2.git
  $ cd wget2
  1. Add upstream repository:
  $ git remote add upstream https://gitlab.com/gnuwget/wget2.git
  1. Build wget2 as explained in README

WARNING: Never commit to branch 'master' or you likely mess up things.

Development

You'll do this periodically. :)

  1. Pick an issue from Issues or

  2. Create new issue if you want to add a new feature

  3. For said issue/feature create a new branch:

    $ git checkout -b <branch_name>

  4. Make your changes using IDE/text editor of your choice.
    Keep up with the coding style that you find, that basically is kernel coding style.

  5. Confirm your changes by building wget2 as explained in README
    Sample build:

     $ ./bootstrap  
 $ ./configure --enable-manywarnings --disable-silent-rules --enable-assert   
 $ make check

  6. git add and git commit your changes:

    $ git add <modified_files>
    $ git commit

    Make sure that your commit message is GNU style (see git log for examples).

  7. Push your changes to your fork:

    $ git push origin <branch_name>

  8. Create a Merge Request (https://gitlab.com/<gitlab_username>/wget2/merge_requests/new) to merge your changes with the upstream

  9. Repeat steps 4, 5, 6 & 7 if more changes are requested.
    Since you are working on your own repository called 'origin', feel free to make any changes to your branch. You may delete and change commits like you want and then pushing them to GitLab with git push -f. This overwrites the history there as well - and that is what you want. If you already made a Merge Request (MR), GitLab will automatically update it for you. There is no need to close a MR and open a new one. Even the Continuous Integration (CI) will start again with your changes.

  10. Delete the local branch and remote branch once your changes get merged:

    $ git branch -d <branch_name>
    $ git push origin --delete <branch_name>

  11. Go to step 1

Syncing Your Fork

You need to do this periodically.

  1. Fetch code from upstream:

    $ git fetch upstream --prune

  2. Switch to master branch:

    $ git checkout master

  3. Merge the code fetched from upstream:

    $ git merge --ff-only upstream/master

  4. Push the merged code to your fork:

    $ git push

Documentation