Take a look at the Xpiks Wiki pages. They contain a lot of topics of how to develop this or that feature as well as architecture overview.

Fork Xpiks repository on GitHub
Clone your fork locally
Configure the upstream repo (git remote add upstream git@github.com:ribtoks/xpiks.git)
Create local branch (git checkout -b your_feature)
Work on your feature
Build project using build instructions
Build and Run tests (xpiks-tests-core and xpiks-tests-integration projects), fix your feature if needed
Push the branch to GitHub (git push origin your_feature)
Make sure all integration tests are green across all platforms
Send a pull request on GitHub

check out an article from user's perspective How to report a bug
gather the logs and/or crash dump (usually this is enough to describe your environment and what have you done)
any additional information like screenshots/screencasts of what is working not as expected is very helpful
if the bug is related to networking, consider running Xpiks with detailed upload logging turned ON

NB! Build will not pass if some of the guidelines are violated!

curly bracket opens on the same line as previous statement
always put a class into a namespace
asterisk or ampersand should be aligned with variable/method name
class fields should go last
class fields variables should be private except very special cases when they can be protected
class fields should be named using the m_CamelCase style (starting with "m_" and then the name starting with the capital letter)
use STL containers for custom classes and Qt containers for Qt classes
try to move as much includes from the header to implementation as possible
methods should be separated by 1 empty line as well as all files should have 1 last empty line
always put space around assignments, after comma, before curly bracket etc.
in the cpp file first include should be appropriate header, then system Qt headers, then system standard C++ headers and only then local headers followed by third-party libs headers
you can use Uncrustify with the config in src/xpiks-qt/ directory for code formatting to ensure you comply with project rules
log using INFO when you have useful parameters and using DEBUG when just marking execution place
write expressive code instead of comments
do not commit commented code though sometimes comments are left in order to demonstrate that something was done on purpose

Provide feedback

Saved searches