-
Notifications
You must be signed in to change notification settings - Fork 24
Working with git
We follow the standard fork and send pull request procedure. Please send your pull requests to raaz-crypto at github.com.
-
Make sure that your version compiles, and the tests succeeds before sending a pull request. We have a continuous build system set up at Travis so we would not merge unless Travis build succeeds. However, it is good to try building and testing it yourselves before sending the pull request. See the section on travis build for more details
-
If you plan to work on multiple stuff or if your pull request is complicated and might require interaction with me before it gets merged, it is better to create a feature branch for it. This way you can continue with other work even when the current request is not merged. Feel free to use and experimental branch (see below) for this.
-
Separate sematic patches (patches that add feature/fixes a bug etc) from cosmetic patches (fixing typos). Documentation changes (other than typos) need to be considered as semantic patch as they alter the semantics (in the human terms)
-
If your pull request has more than one patch, and it fixes a bug please mention the issue number in the pull request and not in each of the individual patches. I will merge this as a non-fast forward merge and include the fixes #issuenumber in the merge message.
The raaz system consists of a collection of haskell packages each in a directory on its own. Usually commits gets merged to the master branch. Normally, for simple patches you might want to send the pull requests to the master branch. However, in case of collaboration on an experimental branch, please feel free to send me pull requests there as well.
Experimental branches as the name suggests are to try out certain features which are half backed. By convention, any branch that starts with the name "x-" will be treated experimental. An experimental branch may be deleted, rebased, renamed or merged. However no rebasing/deleting should happen on the main branches.