Skip to content

Commit

Permalink
Merge pull request #13973 from JuliaLang/teh/docpkgs
Browse files Browse the repository at this point in the history
Add a brief summary of the process of submitting Pkg PRs
  • Loading branch information
timholy committed Nov 16, 2015
2 parents aa24ee0 + 47d4569 commit 7812d49
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions doc/manual/packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -371,9 +371,35 @@ want to make (this is your *commit message*), and then hit "Propose
file change." Your changes will be submitted for consideration by the
package owner(s) and collaborators.

For larger documentation changes---and especially ones that you expect
to have to update in response to feedback---you might find it easier
to use the procedure for code changes described below.

Code changes
~~~~~~~~~~~~

Executive summary
^^^^^^^^^^^^^^^^^

Here we assume you've already set up git on your local machine and
have a GitHub account (see above). Let's imagine you're fixing a bug
in the Images package::

Pkg.checkout("Images") # check out the master branch
<here, make sure your bug is still a bug and hasn't been fixed already>
cd(Pkg.dir("Images"))
;git checkout -b myfixes # create a branch for your changes
<edit code> # be sure to add a test for your bug
Pkg.test("Images") # make sure everything works now
;git commit -a -m "Fix foo by calling bar" # write a descriptive message
Pkg.submit("Images")

The last line will present you with a link to submit a pull request
to incorporate your changes.

Detailed description
^^^^^^^^^^^^^^^^^^^^

If you want to fix a bug or add new functionality, you want to be able
to test your changes before you submit them for consideration. You
also need to have an easy way to update your proposal in response to
Expand Down

0 comments on commit 7812d49

Please sign in to comment.