Contributing

How to contribute

Making changes

As a non collaborator

1. Fork this repository
2. Make a new branch
3. Make your changes
4. Make a pull request
5. Continue to merge master into your branch while your PR waits. You know your code and are thus best suited to fix any merge conflicts that may arise. Then, collaborators can merge cleanly and we'll all be happy.

As a collaborator

1. Make a new branch on this repository
2. Make your changes
3. Make a pull request, and wait for confirmation from other devs. (at least 2)?
4. label it "PR: Ready"

Version releases (Collaborators)

• use git tag
• update CHANGELOG
• update CMakeLists.txt

Standards

Indentation

We are using tabs for indentations. Don't like it? I don't either, but it's our standard so please fucking follow it. Fortunately, we are allowed to use spaces to align code. Will this cause a mess aligning using different tab sizes? Yes. So let's all agree to use tabsize=8, alright? I didn't decide this one.

gTorrent uses astyle to format our code. You can find more about it here

Install astyle, and then run scripts/format.sh at the root of the repo, so that someone else doesn't have to fix your retarded indents

Coding style

We are using Allman/ANSI

• Blocks have their own opening braces.
• Avoid stupid fucking c++ shitty metaprogramming templates whenever possible.

Just use scripts/format.sh

Documentation

libtorrent-rasterbar:

• reference (comprehensive)
• manual (more dev-friendly)