CONTRIBUTING.md

Table of contents

1. Coding style
2. Testing. Writting test cases
3. Generating pacapt script
4. Branches
5. Closed branches

Coding style

1. Don't use tab or smart tab;
2. Use 2-space instead of a tab;
3. Contribute to library file under ./lib/ directory;
4. We try to follow the convention from: https://github.com/icy/bash-coding-style.

Testing. Writting test cases

See also tests/README.md and https://travis-ci.org/icy/pacapt.

1. Use make shellcheck if you have a network connection, and enough Perl packages (JSON, URI::Escape) on your system;
2. Use PACAPT_DEBUG=foo where foo is a package manager (dpkg, pacman, zypper, ...) to print what pacapt will do. Use PACAPT_DEBUG=auto for auto-detection;
3. You can use docker for testing, by mounting the pacapt.dev script to the container. See also docker.i section in Makefile. Example:

$ make pacapt.dev
$ docker run --rm -ti \
    -v $PWD/pacapt.dev:/usr/bin/pacman \
    debian:stable /bin/bash
# you are in container now

Generating pacapt script

1. The pacapt script is generated from the latest stable branch, it is there to make installation process simple;
2. Please do not use make pacapt to update pacapt, and/or modify it manually;
3. For your development, use make pacapt.dev; To generate the table of implemented options, use PACAPT_STATS=1. This table is manually replaced the one in README file.

Branches

1. ng: The current development branch. Some pull requests are merged on to this branch, but the work may not be ready for production.

2. v2.0: The current stable branch. All future v2.x releases come from this branch.

3. your feature branch: For new feature or bug fix, please work on your own branch and create pull request. Do not put different ideas on a same branch because that makes future tracking harder.

Closed branches

1. master: The old stable code of the pacapt. This branch is closed on May 4th, 2014.