File: HACKING.md

package info (click to toggle)
libbytesize 1.4-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 564 kB
  • sloc: python: 1,721; ansic: 952; sh: 681; makefile: 249; xml: 7
file content (36 lines) | stat: -rw-r--r-- 1,009 bytes parent folder | download | duplicates (3)
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
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``).

 - [ ] 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 rsyncing the contents of the *docs/html*
       folder elsewhere, switching to the *gh-pages* branch, rsyncing the
       contents back and commiting it as an update of the docs for the new
       release.