Commits

Jed Brown committed 5085fed

Edited online

  • Participants
  • Parent commits a80f7c1

Comments (0)

Files changed (1)

 # Contributing to PETSc
 
-The most efficient way to create any patch or new functionality is to use a version control system. We recommend git, but can also deal with Mercurial.
+The most efficient way to create any patch or new functionality is to use a version control system. We recommend Git, but can also deal with Mercurial.
 
 ## Contributing a Small Patch
 
-*If you are familiar with the process of sending pull requests through Bitbucket using either git or Mercurial, simply send us one. Otherwise, read on.*
+*If you are familiar with the process of sending pull requests through Bitbucket using either Git or Mercurial, simply send us one. Otherwise, read on.*
 
-The recommended way of creating a patch is to clone the petsc-repository, create a new branch on your local repository from master, apply and commit your changes there, and let git/Mercurial create the patch. Send the patch to [petsc-dev@mcs.anl.gov](mailto:petsc-dev@mcs.anl.gov).
+The recommended way of creating a patch is to clone the petsc-repository, create a new branch on your local repository from master, apply and commit your changes there, and let Git/Mercurial create the patch. Send the patch to [petsc-dev@mcs.anl.gov](mailto:petsc-dev@mcs.anl.gov).
 
 [Read detailed instructions for git](patch-instructions-git)
 
 
 ## Contributing a Larger Piece of Functionality
 
-For changes spanning more than just a few lines, handling patches hampers a quick review and is thus not efficient. Instead, the recommended way is to fork the petsc-repository here on Bitbucket by clicking on 'Fork' on the upper right, clone the forked repository, create a new branch from master and once you are finished with the new feature you send a pull request by clicking on 'Pull request' on the upper right. 
+For changes spanning more than just a few lines, handling patches hampers a quick review and is thus not efficient. Instead, the recommended way is to fork the [PETSc repository](https://bitbucket.org/petsc/petsc) ([Hg mirror](https://bitbucket.org/petsc/petsc-hg-master) here on Bitbucket by clicking on 'Fork' in the upper right. Clone the forked repository, and once you are finished with the new feature, send a pull request by clicking on 'Pull request' on the upper right. 
 
-[Read detailed instructions for git](pull-request-instructions-git)
+[Read detailed instructions for Git](pull-request-instructions-git)
 
 [Read detailed instructions for Mercurial](pull-request-instructions-mercurial)
 
 
 ## PETSc Development Workflow
 
-If you have direct write (push) access to the PETSc repository, you should be familiar with our development workflow. We adapted the master/next-model used by the Linux kernel developers, which allows to develop multiple features at the same time while preserving a stable master-branch.
-
-[Read detailed instructions for git](developer-instructions-git)
+If you have direct write (push) access to the PETSc repository, you should be familiar with our development workflow. We use a simplified version of the `master`/`next` workflow used by the Linux kernel developers. This allows parallel development of multiple features at the same time while preserving a stable `master` branch. The model is explained in [gitworkflows(7)](https://www.kernel.org/pub/software/scm/git/docs/gitworkflows.html) (but we do not currently use a `pu` branch).
 
+[Read detailed instructions for Git](developer-instructions-git)