servatrice/.github/CONTRIBUTING.md

  Introduction | Code Style Guide | Translations | Release Management

---

Contributing to Cockatrice

First off, thanks for taking the time to contribute to our project! 🎉 ❤ ️✨

The following is a set of guidelines for contributing to Cockatrice. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Recommended Setups

For those developers who like the Linux or MacOS environment, many of our developers like working with a nifty program called CLion. The program's a great asset and one of the best tools you'll find on these systems, but you're welcomed to use any IDE you most enjoy.

Developers who like Windows development tend to find Visual Studio the best tool for the job.

If you have any questions on IDEs, feel free to chat with us on Gitter and we would love to help answer your questions!

Code Style Guide

Formatting and continuous integration (ci)

We currently use Travis CI to check your code for formatting issues, if your pull request was rejected because of this it would show a message in the logs. Click on "Details" next to the failed Travis CI build and then click on the failed build (most likely the fastest one) to see the log.

The message will look somewhat similar to this:

************************************************************
*** Your code does not meet our formatting guidelines.   ***
*** Please correct it then commit and push your changes. ***
*** See our CONTRIBUTING.md file for more information.   ***
************************************************************

The CONTRIBUTING.md file mentioned is this file. Please read this section for full information on our formatting guidelines.

Compatibility

Cockatrice is currently compiled on all platforms using C++11. You'll notice C++03 code throughout the codebase. Please feel free to help convert it over!

For consistency, we use Qt data structures where possible. For example, QString over std::string and QList over std::vector.

Formatting

The handy tool clang-format can format your code for you, it is available for almost any environment. A special .clang-format configuration file is included in the project and is used to format your code.

We've also included a bash script, clangify.sh, that will use clang-format to format all files in one go. Use ./clangify.sh --help to show a full help page.

To run clang-format on a single source file simply use the command clang-format -i <filename> to format it in place. (some systems install clang-format with a specific version number appended, find /usr/bin -name clang-format* should find it for you)

See the clang-format documentation for more information about the tool.

Header files

Use header files with the extension .h and source files with the extension .cpp.

Use header guards in the form of FILE_NAME_H.

Simple functions, such as getters, may be written inline in the header file, but other functions should be written in the source file.

Group library includes after project includes, and in alphabetic order. Like this:

// Good
#include "card.h"
#include "deck.h"
#include <QList>
#include <QString>

// Bad
#include <QList>
#include "card.h"
#include <QString>
#include "deck.h"

// Bad
#include "card.h"
#include "deck.h"
#include <QString>
#include <QList>

Naming

Use UpperCamelCase for classes, structs, enums, etc. and lowerCamelCase for function and variable names.

Member variables aren't decorated in any way. Don't prefix or suffix with underscores, etc.

For arguments to constructors which have the same names as member variables, prefix those arguments with underscores:

MyClass::MyClass(int _myData) : myData(_myData)
{

}

Pointers and references should be denoted with the * or & going with the variable name:

// Good
Foo *foo1 = new Foo;
Foo &foo2 = *foo1;

// Bad
Bar* bar1 = new Bar;
Bar& bar2 = *bar1;

Use nullptr instead of NULL (or 0) for null pointers. If you find any usage of the old keywords, we encourage you to fix it.

Braces

Braces should go on their own line except for control statements, the use of braces around single line statements is preferred. See the following example:

int main()
{                                     // function or class: own line
    if (someCondition) {              // control statement: same line
        doSomething();                // single line statement, braces preferred
    } else if (someOtherCondition1) { // else goes on the same line as a closing brace
        for (int i = 0; i < 100; i++) {
            doSomethingElse();
        }
    } else {
        while (someOtherCondition2) {
            doSomethingElse();
        }
    }
}

Indentation and Spacing

Always indent using 4 spaces, do not use tabs. Opening and closing braces should be on the same indentation layer, member access specifiers in classes or structs should not be indented.

All operators and braces should be separated by spaces, do not add a space next to the inside of a brace.

If multiple lines of code that follow eachother have single line comments behind them, place all of them on the same indentation level. This indentation level should be equal to the longest line of code for each of these comments, without added spacing.

Lines

Do not have trailing whitespace in your lines. Most IDEs check for this nowadays and clean it up for you.

Lines should be 120 characters or less. Please break up lines that are too long into smaller parts, for example at spaces or after opening a brace.

Memory Management

New code should be written using references over pointers and stack allocation over heap allocation wherever possible.

// Good: uses stack allocation and references
void showCard(const Card &card);
int main()
{
    Card card;
    showCard(card);
}

// Bad: relies on manual memory management and doesn't give us much
// null-safety.
void showCard(const Card *card);
int main()
{
    Card *card = new Card;
    showCard(card);
    delete card;
}

(Remember to pass by const reference wherever possible, to avoid accidentally mutating objects.)

When pointers can't be avoided, try to use a smart pointer of some sort, such as QScopedPointer, or, less preferably, QSharedPointer.

Database migrations

The servatrice database's schema can be found at servatrice/servatrice.sql. Everytime the schema gets modified, some other steps are due:

1. Increment the value of cockatrice_schema_version in servatrice.sql;
2. Increment the value of DATABASE_SCHEMA_VERSION in servatrice_database_interface.h accordingly;
3. Create a new migration file inside the servatrice/migrations directory named after the new schema version.
4. Run the servatrice/check_schema_version.sh script to ensure everything is fine.

The migration file should include the sql statements needed to migrate the database schema and data from the previous to the new version, and an additional statement that updates cockatrice_schema_version to the correct value.

Ensure that the migration produces the expected effects; e.g. if you add a new column, make sure the migration places it in the same order as servatrice.sql.

Protocol buffer

Cockatrice and Servatrice exchange data using binary messages. The syntax of these messages is defined in the proto files in the common/pb folder. These files defines the way data contained in each message is serialized using Google's protocol buffer. Any change to the proto file should be taken with caution and tested intensively before being merged, becaus a change to the protocol could make new clients incompatible to the old server and vice versa.

You can find more information on how we use Protobuf on our wiki!

Translations

Basic workflow for translations:

1. Developer adds a tr("foo") string in the code;
2. Every few days, a maintainer updates the *_en.ts files with the new strings;
3. Transifex picks up the new files from github every 24 hours;
4. Translators translate the new untranslated strings on Transifex;
5. Before a release, a maintainer fetches the updated translations from Transifex.

Using Translations (for developers)

All the user-interface strings inside Cockatrice's source code must be written in english. Translations to other languages are managed using Transifex.

Adding a new string to translate is as easy as adding the string in the 'tr("")' function, the string will be picked up as translatable automatically and translated as needed. For example setting the text of this label in a way that the string "My name is:" can be translated:

nameLabel.setText(tr("My name is:"));

If you're about to propose a change that adds or modifies any translatable string in the code, you don't need to take care of adding the new strings to the translation files. Every few days, or when a lot of new strings have been added, someone from the development team will take care of extracting all the new strings and adding them to the english translation files and making them available to translators on Transifex.

Maintaining Translations (for maintainers)

When new translatable strings have been added to the code, a maintainer should make them available to translators on Transifex. Every few days, or when a lot of new strings have been added, a maintainer should take care of extracting all the new strings and add them to the english translation files.

To update the english translation files, re-run cmake enabling the appropriate parameter and then run make:

cd cockatrice/build
cmake .. -DUPDATE_TRANSLATIONS=ON
make

If the parameter has been enabled correctly, when running "make" you should see a line similar to this one (the numbers may vary):

[ 76%] Generating ../../cockatrice/translations/cockatrice_en.ts
Updating '../../cockatrice/translations/cockatrice_en.ts'...
Found 857 source text(s) (8 new and 849 already existing)

You should then notice that the following files have uncommitted changes:

cockatrice/translations/cockatrice_en.ts
oracle/translations/oracle_en.ts

It is recommended to disable the parameter afterwards using:

cmake .. -DUPDATE_TRANSLATIONS=OFF

Now you are ready to propose your change.

Once your change gets merged, Transifex will pick up the modified files automatically (checked every 24 hours) and update the interface where translators will be able to translate the new strings.

Releasing Translations (for maintainers)

Before rushing out a new release, a maintainer should fetch the most up to date translations from Transifex and commit them into the Cockatrice source code. This can be done manually from the Transifex web interface, but it's quite time consuming.

As an alternative, you can install the Transifex CLI:

http://docs.transifex.com/developer/client/

You'll then be able to use a git-like cli command to push and pull translations from Transifex to the source code and vice versa.

Adding Translations (for translators)

As a translator you can help translate the new strings on Transifex. Please have a look at the specific FAQ for translators.

Release Management

Publishing A New Beta Release

Travis and AppVeyor have been configured to upload files to GitHub Releases whenever a tag is pushed.
Usually, tags are created through publishing a (pre-)release, but there's a way around that.

To trigger Travis and AppVeyor, simply do the following:

cd $COCKATRICE_REPO
git checkout master
git remote update -p
git pull
git tag $TAG_NAME
git push upstream $TAG_NAME

You should define the variables as such:

upstream - git@github.com:Cockatrice/Cockatrice.git
$COCKATRICE_REPO - /Location/of/repository/cockatrice.git
`$TAG_NAME` should be:
  - `YYYY-MM-DD-Release-MAJ.MIN.PATCH` for **stable releases**
  - `YYYY-MM-DD-Development-MAJ.MIN.PATCH-beta.X` for **beta releases**<br>
    With *MAJ.MIN.PATCH* being the NEXT release version!

This will cause a tagged release to be established on the GitHub repository, which will then lead to the upload of binaries. If you use this method, the tags (releases) that you create will be marked as a "Pre-release". The /latest URL will not be impacted (for stable release downloads) so that's good.

If you accidentally push a tag incorrectly (the tag is outdated, you didn't pull in the latest branch accidentally, you named the tag wrong, etc.) you can revoke the tag by doing the following:

git push --delete upstream $TAG_NAME
git tag -d $TAG_NAME

NOTE: Unfortunately, due to the method of how Travis and AppVeyor work, to publish a stable release you will need to make a copy of the release notes locally and then paste them into the GitHub GUI once the binaries have been uploaded by them. These CI services will automatically overwrite the name of the release (to "Cockatrice $TAG_NAME"), the status of the release (to "Pre-release"), and the release body (to "Beta build of Cockatrice").

NOTE 2: In the first lines of https://github.com/Cockatrice/Cockatrice/blob/master/CMakeLists.txt there's an hardcoded version number used when compiling custom (not tagged) versions. While on tagged versions these numbers are overridden by the version numbers coming from the tag title, it's good practice to keep them aligned with the real ones. The preferred flow of operation is:

• just before a release, update the version number in CMakeLists.txt to "next release version";
• tag the release following the previously described syntax in order to get it built by CI;
• wait for CI to upload the binaries, double check if everything is in order
• after the release is complete, update the version number again to "next targeted beta version", typically increasing PROJECT_VERSION_PATCH by one.

NOTE 3: When releasing a new stable version, all the previous beta versions should be deleted. This is needed for Cockatrice to update users of the "beta" release channel to the latest version like other users.