File: HACKING.md

package info (click to toggle)
libbytesize 2.12-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 788 kB
  • sloc: python: 1,854; ansic: 994; sh: 666; makefile: 258
file content (39 lines) | stat: -rw-r--r-- 1,193 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
CODING STYLE
============

 - Please follow the coding style already used.

 - Spaces, not tabs, are used (except for Makefiles).


MAKING RELEASES
===============

 - [ ] ``sudo git clean -xdf``

 - [ ] ``./autogen.sh && ./configure``

 - [ ] ``make bumpver``

 - [ ] Add a new entry to the *NEWS.rst* file (full list of changes should be
       generated with ``make shortlog``).

 - [ ] Regenerate the bscalc.man manpage by installing bscalc and then running
       ``help2man -N bscalc > PATH_TO_LIBBYTESIZE/tools/bscalc.man``.

 - [ ] Commit all the changes as *New version - $VERSION*.

 - [ ] ``make release`` (requires a GPG key to sign the tag)

 - [ ] ``git push && git push --tags``

 - [ ] Edit the new release (for the new tag) at GitHub and:

   - [ ] add some detailed information about it (from the *NEWS.rst*) file to it,

   - [ ] upload the tarball created above (``make release``) to the release.

 - [ ] Update the documentation by copying the contents of the *docs/html*
       folder to the *libbytesize* directory in the
       [Storaged project website repository](https://github.com/storaged-project/storaged-project.github.io)
       and commit and push the changes