diff options
| author | Kali Kaneko <kali@leap.se> | 2015-08-31 14:54:52 -0400 |
|---|---|---|
| committer | Kali Kaneko <kali@leap.se> | 2015-08-31 14:54:52 -0400 |
| commit | f4547479fc050f338845f4f546d8dd7c0e4512eb (patch) | |
| tree | 0f737c7f102674230f5467ecaf17720e1d28f6eb /docs | |
| parent | dd43dad4b150adb66e571a56a8a5c053dec858d0 (diff) | |
| parent | fd27f48a35736d8ba186c423a7de15ffee5143dd (diff) | |
Merge tag '0.9.0rc2' into debian/experimental
Tag leap.bitmask version 0.9.0rc2
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/workflow.rst | 2 | ||||
| -rwxr-xr-x | docs/leap-autopep8.post-commit.hook | 15 | ||||
| -rwxr-xr-x | docs/leap-autopep8.post-commit.hook.ADD | 2 | ||||
| -rw-r--r-- | docs/leap-commit-template | 7 | ||||
| -rw-r--r-- | docs/leap-commit-template.README | 47 | ||||
| -rwxr-xr-x | docs/leap-flake8.pre-commit.hook | 7 | ||||
| -rw-r--r-- | docs/testing-rcs.README | 35 |
7 files changed, 114 insertions, 1 deletions
diff --git a/docs/dev/workflow.rst b/docs/dev/workflow.rst index f217df24..689b8feb 100644 --- a/docs/dev/workflow.rst +++ b/docs/dev/workflow.rst @@ -48,7 +48,7 @@ All code ready to be merged into the integration branch is expected to: * Have tests * Be documented -* Pass existing tests: do **run_tests.sh** and **tox -v**. All feature branches are automagically built by our `buildbot farm <http://lemur.leap.se:8010/grid>`_. So please check your branch is green before merging it it to `develop`. Rebasing against the current tip of the integration when possible is preferred in order to keep a clean history. +* Pass existing tests: do **run_tests.sh** and **tox -v**. Rebasing against the current tip of the integration when possible is preferred in order to keep a clean history. Using Github ------------ diff --git a/docs/leap-autopep8.post-commit.hook b/docs/leap-autopep8.post-commit.hook new file mode 100755 index 00000000..cffb1d53 --- /dev/null +++ b/docs/leap-autopep8.post-commit.hook @@ -0,0 +1,15 @@ +#!/bin/sh + +# Auto pep8 correction as a post-commit hook. +# Thanks to http://victorlin.me/posts/2014/02/05/auto-post-commit-pep8-correction + +echo "[+] running autopep8..." +FILES=$(git diff HEAD^ HEAD --name-only --diff-filter=ACM | grep -e '\.py$') + +for f in $FILES +do + # auto pep8 correction + autopep8 --in-place $f +done + +git status diff --git a/docs/leap-autopep8.post-commit.hook.ADD b/docs/leap-autopep8.post-commit.hook.ADD new file mode 100755 index 00000000..b6e07ae5 --- /dev/null +++ b/docs/leap-autopep8.post-commit.hook.ADD @@ -0,0 +1,2 @@ + #!/bin/sh + cd .git/hooks && ln -s ../../docs/leap-autopep8.post-commit.hook post-commit diff --git a/docs/leap-commit-template b/docs/leap-commit-template new file mode 100644 index 00000000..8a5c7cd0 --- /dev/null +++ b/docs/leap-commit-template @@ -0,0 +1,7 @@ +[bug|feat|docs|style|refactor|test|pkg|i18n] ... +... + +- Resolves: #XYZ +- Related: #XYZ +- Documentation: #XYZ +- Releases: XYZ diff --git a/docs/leap-commit-template.README b/docs/leap-commit-template.README new file mode 100644 index 00000000..ce8809e7 --- /dev/null +++ b/docs/leap-commit-template.README @@ -0,0 +1,47 @@ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +HOW TO USE THIS TEMPLATE: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Run `git config commit.template docs/leap-commit-template` or +edit the .git/config for this project and add +`template = docs/leap-commit-template` +under the [commit] block + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +COMMIT TEMPLATE FORMAT EXPLAINED +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +[type] <subject> + +<body> +<footer> + +Type should be one of the following: +- bug (bug fix) +- feat (new feature) +- docs (changes to documentation) +- style (formatting, pep8 violations, etc; no code change) +- refactor (refactoring production code) +- test (adding missing tests, refactoring tests; no production code change) +- pkg (packaging related changes; no production code change) +- i18n translation related changes + +Subject should use imperative tone and say what you did. +For example, use 'change', NOT 'changed' or 'changes'. + +The body should go into detail about changes made. + +The footer should contain any issue references or actions. +You can use one or several of the following: + +- Resolves: #XYZ +- Related: #XYZ +- Documentation: #XYZ +- Releases: XYZ + +The Documentation field should be included in every new feature commit, and it +should link to an issue in the bug tracker where the new feature is analyzed +and documented. + +For a full example of how to write a good commit message, check out +https://github.com/sparkbox/how_to/tree/master/style/git diff --git a/docs/leap-flake8.pre-commit.hook b/docs/leap-flake8.pre-commit.hook new file mode 100755 index 00000000..b00fd08a --- /dev/null +++ b/docs/leap-flake8.pre-commit.hook @@ -0,0 +1,7 @@ +#!/bin/sh +# Auto-check for pep8 so I don't check in bad code +FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -e '\.py$') + +if [ -n "$FILES" ]; then + flake8 -r $FILES +fi diff --git a/docs/testing-rcs.README b/docs/testing-rcs.README new file mode 100644 index 00000000..b0340f0a --- /dev/null +++ b/docs/testing-rcs.README @@ -0,0 +1,35 @@ +Tips for QA +------------ + +From time to time, we'll ask the community for help testing a new alpha release +or a release candidate. Normally, we'll offer a link for the download of a +self-contained bundle just for internal testing purposes. These will be updated +quite often, as soon as there are fixes available to fix the release-critical +bugs. + +If you want to give a hand in this process, please follow the following tips: + +- Focus all your efforts, if possible, on whatever is *the* golden distro at + the time of the release. This currently is: Ubuntu 14.04.x LTS, 64bits, with +Unity as the default desktop environment. + It's very important to have a reference environment as bug-free as possible, + before trying to solve issues that are present in other distributions or window + managers. +- Identify all issues that need help in the QA phase. You can do that going to + the bug tracker, and filtering all the issues for a given release that are in + the QA state. +- If the issue is solved in your tests for this alpha release, please add a + comment to the issue stating the results of your tests, and the platform and + desktop environment in which your tests took place. But please do not change + the QA status on the issue. We generally leave this role to the author of the + original issue, or to the person playing the role of the release QA master. +- Always test with a newly created account (specially relevant when testing + email candidates) +- Always test with the reference Mail User Agent (currently, Thunderbird, in + whatever version is present in the reference distribution). +- Remove also any thunderbird configuration, start a freshly configured account. +- If you find a new bug, please make sure that it hasn't already been reported + in the issue tracker. If you are absolutely certain that you have found a new + bug, please attach a log of a new bitmask session, which should contain + *only* the behaviour needed to reproduce the bug you are reporting. + |