[julia-users] Re: Contributing to a Julia Package
Another slightly OT remark, that I believe many might find useful, is that the [github hub project](https://github.com/github/hub) is really worth checking out. It's basically a super-set of `git`, intended to be aliased (`alias git=hub` on e.g. ubuntu), and it forwards any regular `git` command to regular `git`. However, it also adds a bunch of sweet features like `git pull-request` which will do all the required steps to create a pull request to merge the current branch into `origin/master`, including creating a fork etc if it's necessary. You get a url to the pull-request in the UI =) It requires you to have a Github account and to configure both `git` and `hub` to be aware of (and have access to via ssh) that account, but there are really nice instructions in the docs for the `hub` project. // T On Monday, November 10, 2014 9:58:15 PM UTC+1, Ivar Nesje wrote: Another important point (for actively developed packages) is that Pkg.add() checks out the commit of the latest released version registered in METADATA.jl. Most packages do development on the master branch, so you should likely base your changes on master, rather than the latest released version. To do this, you can use `Pkg.checkout()`, but `git checkout master` will also work. Ivar kl. 21:07:49 UTC+1 mandag 10. november 2014 skrev Tim Wheeler følgende: Thank you! It seems to have worked. Per João's suggestions, I had to: - Create a fork on Github of the target package repository - Clone my fork locally - Create a branch on my local repository - Add, commit, push my changes to said branch - On github I could then submit the pull request from my forked repo to the upstream master On Monday, November 10, 2014 11:17:55 AM UTC-8, Tim Wheeler wrote: Hello Julia Users, I wrote some code that I would like to submit via pull request to a Julia package. The thing is, I am new to this and do not understand the pull request process. What I have done: - used Pkg.add to obtain a local version of said package - ran `git branch mybranch` to create a local git branch - created my code additions and used `git add` to include them. Ran `git commit -m` I am confused over how to continue. The instructions on git for issuing a pull request require that I use their UI interface, but my local branch is not going to show up when I select new pull request because it is, well, local to my machine. Do I need to fork the repository first? When I try creating a branch through the UI I do not get an option to create one like they indicate in the tutorial https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/#creating-a-branch, perhaps because I am not a repo owner. Thank you.
[julia-users] Re: Contributing to a Julia Package
Thank you! It seems to have worked. Per João's suggestions, I had to: - Create a fork on Github of the target package repository - Clone my fork locally - Create a branch on my local repository - Add, commit, push my changes to said branch - On github I could then submit the pull request from my forked repo to the upstream master On Monday, November 10, 2014 11:17:55 AM UTC-8, Tim Wheeler wrote: Hello Julia Users, I wrote some code that I would like to submit via pull request to a Julia package. The thing is, I am new to this and do not understand the pull request process. What I have done: - used Pkg.add to obtain a local version of said package - ran `git branch mybranch` to create a local git branch - created my code additions and used `git add` to include them. Ran `git commit -m` I am confused over how to continue. The instructions on git for issuing a pull request require that I use their UI interface, but my local branch is not going to show up when I select new pull request because it is, well, local to my machine. Do I need to fork the repository first? When I try creating a branch through the UI I do not get an option to create one like they indicate in the tutorial https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/#creating-a-branch, perhaps because I am not a repo owner. Thank you.
[julia-users] Re: Contributing to a Julia Package
Another important point (for actively developed packages) is that Pkg.add() checks out the commit of the latest released version registered in METADATA.jl. Most packages do development on the master branch, so you should likely base your changes on master, rather than the latest released version. To do this, you can use `Pkg.checkout()`, but `git checkout master` will also work. Ivar kl. 21:07:49 UTC+1 mandag 10. november 2014 skrev Tim Wheeler følgende: Thank you! It seems to have worked. Per João's suggestions, I had to: - Create a fork on Github of the target package repository - Clone my fork locally - Create a branch on my local repository - Add, commit, push my changes to said branch - On github I could then submit the pull request from my forked repo to the upstream master On Monday, November 10, 2014 11:17:55 AM UTC-8, Tim Wheeler wrote: Hello Julia Users, I wrote some code that I would like to submit via pull request to a Julia package. The thing is, I am new to this and do not understand the pull request process. What I have done: - used Pkg.add to obtain a local version of said package - ran `git branch mybranch` to create a local git branch - created my code additions and used `git add` to include them. Ran `git commit -m` I am confused over how to continue. The instructions on git for issuing a pull request require that I use their UI interface, but my local branch is not going to show up when I select new pull request because it is, well, local to my machine. Do I need to fork the repository first? When I try creating a branch through the UI I do not get an option to create one like they indicate in the tutorial https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/#creating-a-branch, perhaps because I am not a repo owner. Thank you.
