Skip to content

Commit

Permalink
HACKING: Warn against cloning a fork
Browse files Browse the repository at this point in the history
New contributors keep trying this and fail, this has become a FAQ.
Explicitly point out that the given clone command is not an accident,
but deliberate, and show how to work with a fork.
  • Loading branch information
martinpitt authored and jelly committed Jun 6, 2023
1 parent fe26c62 commit ec1afd6
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ Start by getting the code:
The remainder of the commands assume you're in the top level of the
Cockpit git repository checkout.

**Do not clone a fork!** This will not work for various reasons (missing tags,
determining version, integration with bots commands). Please keep `origin` as
the read-only actual upstream project, and add your fork as a separate writable
remote, for example with

git remote add my git@github.com:yourgithubid/cockpit.git

## Setting up development container

The cockpit team maintains a [cockpit/tasks container](https://quay.io/repository/cockpit/tasks)
Expand Down

0 comments on commit ec1afd6

Please sign in to comment.