github howto

This page describes experiments the Kea team is conducting to find a viable Trac replacement.

NOTE: This is an experiment.

Github setup

• Add your SSH key to github. Click on your profile icon, settings, ssh and gpg keys (or go directly to https://github.com/settings/profile/keys), upload your ssh key there.

• Clean up your existing repository:

git checkout master
git clean -fxd
git pull

• Add gitlab as an additional repository:

git remote add github [email protected]:isc-projects/kea.git

• Pull any changes (since github master is synced with ISC internal repo, there shouldn't be any)

git fetch github

Working on an issue

• pick up a ticket in trac that you want to copy. Mark it somehow in that that it's being handeld in github.
• create issue on github: https://github.com/isc-projects/kea/issues, click new issue. Make sure it's assigned to Kea1.5 milestone. Assign labels as necessary. Add new label if needed.
• Assign the issue to yourself.
• View issues currently assigned to you. Go to issues (https://github.com/isc-projects/kea/issues, click on author and click on your login).
• Create a branch with a name that is related to the issue. Commit your changes to that branch, push it to github.
• Once you're done, go to https://github.com/isc-projects/kea/pulls, click New pull request, select your branch, review your changes, click Create Pull Request.
• Unassign yourself from the issue. Add review label.

Reviewing an issue

• as a reviewer: go to pull requests (https://github.com/isc-projects/kea/pulls). You may want to use filter, e.g. to find PRs from kea1.5 milestone. Pick one, assign it to yourself. Click on Files changed (e.g. https://github.com/isc-projects/kea/pull/88/files), then click on any changes you want to comment on. With the first comment added, there will be a Start a review button. Once all your comments are in, click on the right side Review Changes. Once you're done, assign the PR back to the developer.
• as a developer: look for issues assigned to you. github will send you mail when your PR is being updated. If you don't like that, click on Notifications->Unsubscribe on the right panel. Once you receive comments, please update the code as needed, push them to the branch. Those should appear immediately as soon as you push your updated branch to github.
• Once every comment is resolved and the changes are ready for merge, you should have two choices:
  • rebase your branch and merge your changes to master, push them to our internal master. That will be pushed to github and the PR will be closed.
  • if there are no conflicts, go to the PR page and click rebase and merge. github will do its magic and rebase/merge your changes to master and will close the PR. You need to push those changes manually to our internal repo, otherwise it will get out of sync.
• Write down your thoughts. If needed, please update this page. It's an experiment. Let's try to make it a successful one.