Skip to content

Commit d1e95ac

Browse files
committed
Fixes to documentation on contributing
Fixes #579
1 parent dbd93e2 commit d1e95ac

File tree

2 files changed

+23
-12
lines changed

2 files changed

+23
-12
lines changed

Diff for: CONTRIBUTING.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

2-
Build from repository
3-
---------------------
2+
Building from git clone
3+
-----------------------
44

55
``` shell
66
$ ./bootstrap
@@ -44,6 +44,7 @@ You can now run the python script. Example:
4444
$ $HOME/redshift/root/bin/redshift-gtk
4545
```
4646

47+
4748
Dependencies
4849
------------
4950

@@ -57,18 +58,19 @@ Dependencies
5758
* python3, pygobject, pyxdg (Optional, for GUI support)
5859
* appindicator (Optional, for Ubuntu-style GUI status icon)
5960

60-
Ubuntu users will find all these dependencies in the packages listed in ``.travis.yml``.
61+
Ubuntu users will find all these dependencies in the packages listed in ``.travis.yml``.
6162

62-
Coding style
63-
------------
63+
64+
Coding style for C code
65+
-----------------------
6466

6567
Redshift follows roughly the Linux coding style
6668
<http://www.kernel.org/doc/Documentation/CodingStyle>. Some specific rules to
6769
note are:
6870

69-
* Lines should not be much longer than 80 chars but this is not strictly
70-
enforced. If lines are much longer than this the code could likely be improved
71-
by moving some parts to a smaller function.
71+
* Lines should not be longer than 80 characters in new code. If lines are
72+
longer than this the code could likely be improved by moving some parts to a
73+
smaller function.
7274
* All structures are typedef'ed.
7375
* Avoid Yoda conditions; they make the logic unnecessarily hard to comprehend.
7476
* Avoid multiline if-statements without braces; either use a single line or add
@@ -98,7 +100,7 @@ Creating a pull request
98100
5. Discussion will ensue. If you are not prepared to partake in the discussion
99101
or further improve your patch for inclusion, please say so and someone else
100102
may be able to take on responsibility for your patch. Otherwise we will
101-
assume that you will be open to critisism and suggestions for improvements
103+
assume that you will be open to criticism and suggestions for improvements
102104
and that you will take responsibility for further improving the patch. You
103105
can add further commits to your topic branch and they will automatically be
104106
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
118120
the `master` branch as `develop`.
119121

120122

123+
Contributing translations
124+
-------------------------
125+
126+
You can contribute translations directly at
127+
[Launchpad Translations for Redshift](https://translations.launchpad.net/redshift).
128+
Updated translations will be pulled back into the `po` files on Github
129+
before a release is made.
130+
131+
121132
Creating a new release
122133
----------------------
123134

Diff for: README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Latest builds from master branch
126126
- [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)
127127
- [Windows x86](https://ci.appveyor.com/api/projects/jonls/redshift/artifacts/redshift-windows-i686.zip?branch=master&job=Environment%3A+arch%3Di686&pr=false)
128128

129-
Building from source
130-
--------------------
129+
Contributing / Building from source
130+
-----------------------------------
131131

132-
See the file [CONTRIBUTING](CONTRIBUTING.md) for more details on building from source.
132+
See the file [CONTRIBUTING](CONTRIBUTING.md) for more details.

0 commit comments

Comments
 (0)