Skip to content

Latest commit

 

History

History
130 lines (90 loc) · 4.87 KB

CONTRIBUTING.md

File metadata and controls

130 lines (90 loc) · 4.87 KB
Raw

CONTRIBUTING GUIDELINES

Here are some guidelines for people who want to contribute their code to this software.

Make separate commits for logically separate changes.

Be picky about whitespace

This project is very picky about code style. The style here is the standard Python PEP-8 style:

http://www.python.org/dev/peps/pep-0008/

  • We use 4-space indents.

  • We use variable_names_with_underscores. No camelCase. The only exception is when overriding Qt functions.

  • Do not introduce trailing whitespace. The "Diff" viewer displays trailing whitespace in red, or you can use "git diff --check".

  • Generally, follow the same style as the existing code.

Describe your changes well.

The first line of the commit message should be a short description (50 characters is the soft limit, see DISCUSSION in git-commit(1)), and should skip the full stop. It is also conventional in most cases to prefix the first line with "area: " where the area is a filename or identifier for the general area of the code being modified, e.g.

  • push: allow pushing to multiple remotes

  • grep: allow passing in command-line arguments

If in doubt which identifier to use, run "git log --no-merges" on the files you are modifying to see the current conventions.

The body should provide a meaningful commit message, which:

  • explains the problem the change tries to solve, iow, what is wrong with the current code without the change.

  • justifies the way the change solves the problem, iow, why the result with the change is better.

  • alternate solutions considered but discarded, if any.

Describe your changes in imperative mood, e.g. "make xyzzy do frotz" instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy to do frotz", as if you are giving orders to the codebase to change its behaviour. Try to make sure your explanation can be understood without external resources. Instead of giving a URL to a mailing list archive, summarize the relevant points of the discussion.

If you like, you can put extra tags at the end:

  • "Reported-by:" is used to credit someone who found the bug that the patch attempts to fix.

  • "Acked-by:" says that the person who is more familiar with the area the patch attempts to modify liked the patch.

  • "Reviewed-by:", unlike the other tags, can only be offered by the reviewer and means that she is completely satisfied that the patch is ready for application. It is usually offered only after a detailed review.

  • "Tested-by:" is used to indicate that the person applied the patch and found it to have the desired effect.

You can also create your own tag or use one that's in common usage such as "Thanks-to:", "Based-on-patch-by:", or "Helped-by:".

Sign your work

To improve tracking of who did what, we've borrowed the "sign-off" procedure from the Linux kernel project on patches that are being emailed around. Although core Git is a lot smaller project it is a good discipline to follow it.

The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as a open-source patch. The rules are pretty simple: if you can certify the below:

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

then you just add a line saying

Signed-off-by: Random J Developer [email protected]

This line can be automatically added by Git if you run the git-commit command with the -s option.

Notice that you can place your own Signed-off-by: line when forwarding somebody else's patch with the above rules for D-C-O. Indeed you are encouraged to do so. Do not forget to place an in-body "From: " line at the beginning to properly attribute the change to its true author (see (2) above).

Also notice that a real name is used in the Signed-off-by: line. Please don't hide your real name.

Fork the repo on Github and create a pull request.