diff options
| author | Jon Lund Steffensen <jonlst@gmail.com> | 2018-10-20 19:42:10 -0700 |
|---|---|---|
| committer | Jon Lund Steffensen <jonlst@gmail.com> | 2018-10-20 19:42:10 -0700 |
| commit | d1e95ac14b4607794a9cf9281b183db4f61589c6 (patch) | |
| tree | 08836a9f5e0ce33913ce67a40af8d2579f4a9efa | |
| parent | Merge pull request #673 from clefebvre/symbolic-status-icons (diff) | |
| download | redshift-ng-d1e95ac14b4607794a9cf9281b183db4f61589c6.tar.gz redshift-ng-d1e95ac14b4607794a9cf9281b183db4f61589c6.tar.bz2 redshift-ng-d1e95ac14b4607794a9cf9281b183db4f61589c6.tar.xz | |
Fixes to documentation on contributing
Fixes #579
| -rw-r--r-- | CONTRIBUTING.md | 29 | ||||
| -rw-r--r-- | README.md | 6 |
2 files changed, 23 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ad02f8..c8a29e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -Build from repository ---------------------- +Building from git clone +----------------------- ``` shell $ ./bootstrap @@ -44,6 +44,7 @@ You can now run the python script. Example: $ $HOME/redshift/root/bin/redshift-gtk ``` + Dependencies ------------ @@ -57,18 +58,19 @@ Dependencies * python3, pygobject, pyxdg (Optional, for GUI support) * appindicator (Optional, for Ubuntu-style GUI status icon) -Ubuntu users will find all these dependencies in the packages listed in ``.travis.yml``. +Ubuntu users will find all these dependencies in the packages listed in ``.travis.yml``. -Coding style ------------- + +Coding style for C code +----------------------- Redshift follows roughly the Linux coding style <http://www.kernel.org/doc/Documentation/CodingStyle>. Some specific rules to note are: -* Lines should not be much longer than 80 chars but this is not strictly - enforced. If lines are much longer than this the code could likely be improved - by moving some parts to a smaller function. +* Lines should not be longer than 80 characters in new code. If lines are + longer than this the code could likely be improved by moving some parts to a + smaller function. * All structures are typedef'ed. * Avoid Yoda conditions; they make the logic unnecessarily hard to comprehend. * Avoid multiline if-statements without braces; either use a single line or add @@ -98,7 +100,7 @@ Creating a pull request 5. Discussion will ensue. If you are not prepared to partake in the discussion or further improve your patch for inclusion, please say so and someone else may be able to take on responsibility for your patch. Otherwise we will - assume that you will be open to critisism and suggestions for improvements + assume that you will be open to criticism and suggestions for improvements and that you will take responsibility for further improving the patch. You can add further commits to your topic branch and they will automatically be added to the pull request when you push them to Github. @@ -118,6 +120,15 @@ If you want to learn more about the Git branching model that we use please see the `master` branch as `develop`. +Contributing translations +------------------------- + +You can contribute translations directly at +[Launchpad Translations for Redshift](https://translations.launchpad.net/redshift). +Updated translations will be pulled back into the `po` files on Github +before a release is made. + + Creating a new release ---------------------- @@ -126,7 +126,7 @@ Latest builds from master branch - [Windows x86_64](https://ci.appveyor.com/api/projects/jonls/redshift/artifacts/redshift-windows-x86_64.zip?branch=master&job=Environment%3A+arch%3Dx86_64&pr=false) - [Windows x86](https://ci.appveyor.com/api/projects/jonls/redshift/artifacts/redshift-windows-i686.zip?branch=master&job=Environment%3A+arch%3Di686&pr=false) -Building from source --------------------- +Contributing / Building from source +----------------------------------- -See the file [CONTRIBUTING](CONTRIBUTING.md) for more details on building from source. +See the file [CONTRIBUTING](CONTRIBUTING.md) for more details. |