Forking the repository to make a push request

#1

All,

I’ve been coding for a long time, but I’m not particularly fluent with github.

I’ve got a couple of files to donate to the Ardour project, a midimap for a control surface, and a midnam file. Also, I’d like to fix some minor issues in the documentation.

I joined the developers mailing list.

On my github account, do I fork or branch the Ardour repository?
Any quick help or pointers on what to read would be appreciated.

Thank you.

1 Like
#2

So I’ll give the general answer for GitHub below:

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

And that is a perfectly acceptable way to do this. I should note that the Github repo is actually a mirror of the actual ardor git, but I believe they accept pull requests on GitHub just fine IIRC.

  Seablade
1 Like
#3

Correct :slight_smile:

#4

A couple of hints here, in case those docs aren’t clear:

  • You want to fork the repository, rather than asking for perms to make a branch in the official one (and as @seablade notes, the Github repo is one step removed already).
  • In your fork, you then want to make a branch for each distinct change you propose pushing back. E.g., once you have cloned your fork, immediately make a branch:
$ git clone https://github.com/<your-GH-user-id>/ardour
$ cd ardour
$ git switch -c <your-GH-user-id>-<short-desc-of-proposed-fix> master
# now make your changes, compile, and test.
$ git add .  # includes any not-yet-in-git files
$ git commit -m "<describe proposed fix"
$ git push origin <branch-name-from-above>
# and then use the link in the output to open a pull request
  • For the love of all that is holy, please don’t make your changes on the master branch of your fork: you want that branch to be pristine, so that you can pull it periodically from upstream.
3 Likes
#5

Thank you. I’ll set to work.
For now I want to add a midi map and a midnam file.
Later I plan to do some work on the manual.

#6

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.