Contributing

(For a list of ideas from small to big to hack on, jump to Ideas)

We are very open and accepting, so you may just try to throw code at us and then we can work out details together!

Getting Started

Having said that, we generally try to follow the "Fork & pull" Github model. In steps that would be:

1. Fork github.com/haskell/haskell-mode.

2. Clone the repo locally:

   git clone [email protected]/xxx/haskell-mode
   

   where xxx is your account at github.com.

3. Make the fixes.

4. Make a branch:

   git checkout -b pr-foobar-improvements
   

5. Commit:

   git commit -a -m "Super important foobar improvements"
   

6. Push to your repo at github. git push

7. Create a pull request by logging into github.com and clicking some green buttons.

Advanced: Updating Pull Request

So far so good. Pull request is there, it might require some polishing

1. Add upstream remote:

   git remote add haskell git://github.com/haskell/haskell-mode.git
   

2. Rebase on top of current master in upstream repo:

   git fetch haskell
   git rebase haskell/master
   

3. Pushing updated commits:

   git push origin +pr-foobar-improvements
   

Note that it is ok to update commits until they are merged into master. After that point they are permanent history and should never ever change.

Final Touches

Once your PR was merged, delete your branch:

git push origin :pr-foobar-improvements
git fetch --prune

Licensing

The haskell-mode is distributed under GNU General Public License¹, please follow these instructions:

1. Update Copyright notice — add your name, and update year if needed when modifying existing files.

2. When adding new files place copyright notice followed by copyright permission statement:

   This file is part of haskell-mode package.
   
   Foobar is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   
   Foobar is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
   

More details about GNU GPL - How to use GNU licenses for your own software.

Have Fun!