CONTRIBUTING.md 1.35 KB
Newer Older
1
2
3
Want to get involved? Great!
============================

4
Make sure you have an up-to-date Haskell toolchain. I recommend using
5
6
[Stack](https://haskellstack.org/) for development. Make sure you run
`stack update` if you install it from a distro package before continuing.
7

8
9
Grab the latest code from git:

10
    git clone https://gitlab.freedesktop.org/bustle/bustle.git
11
12
13
14
15
16
17
18
19
20
21
22
23
    cd bustle

Build it:

    stack build

Run it:

    stack exec bustle

Test it:

    stack test
24

25
Please file bugs and merge requests at
26
<https://gitlab.freedesktop.org/bustle/bustle>.
27
28
29

In new code, try to follow
<https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md>.
30
The author did not follow it in the past but it seems like a good kind of
31
thing to aim for.
32
33
34
35
36

Releasing Bustle
================

* Ideally, automate the steps below
Will Thompson's avatar
Will Thompson committed
37
* Write news in `NEWS.md` and `data/org.freedesktop.Bustle.appdata.xml.in`
38
39
40
41
42
43
44
45
46
47
48
49
* Update version number in `bustle.cabal`

```sh
# Tag release, build and sign the tarballs
make maintainer-make-release

# Stick source and binaries on freedesktop.org
mkdir x.y.z
cp dist/bustle-x.y.z* x.y.z/
scp -r x.y.z annarchy.freedesktop.org:/srv/www.freedesktop.org/www/software/bustle/

# Upload source to Hackage
Will Thompson's avatar
Will Thompson committed
50
stack upload .
51
52
53

git push origin --tags master
```
Will Thompson's avatar
Will Thompson committed
54
55
56

* Add `.1` to version number in `bustle.cabal`
* Update <https://github.com/flathub/org.freedesktop.Bustle>