6.5 KiB
Filing an issue
Must read
- If you aren't sure, you can ask on the IRC channel or read our wiki first.
- Do a quick search. Others might have already reported the issue.
- Write in English!
- Provide version information (you can find version numbers in menu
Settings → About):
OS:
qTox version:
Commit hash:
toxcore:
Qt:
- Provide steps to reproduce the problem, it will be easier to pinpoint the fault.
- Screenshots! A screenshot is worth a thousand words. Just upload it. (How?)
Good to know
- Patience. The dev team is small and resource limited. Devs have to find time, analyze the problem and fix the issue, it all takes time. 🕒
- If you can code, why not become a contributor by fixing the issue and opening a pull request? 😉
- Harsh words or threats won't help your situation. What's worse, your complaint will (very likely) be ignored. 😨
Opening a pull request
Must read
- Use commit message format.
- Read our coding guidelines.
- Keep the title short and provide a clear description about what your pull request does.
- Provide screenshots for UI related changes.
- Keep your git commit history clean and precise. Commits like
xxx fixupshould not appear. - If your commit fixes a reported issue (for example #4134), add the following
message to the commit
Fixes #4134.. Here is an example.
Good to know
- Search the pull request history! Others might have already implemented your idea and it could be waiting to be merged (or have been rejected already). Save your precious time by doing a search first.
- When resolving merge conflicts, do
git rebase <target_branch_name>, don't dogit pull. Then you can start fixing the conflicts. Here is a good explanation.
Git Commit Guidelines
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the qTox change log using clog-cli.
Commit Message Format
Each commit message consists of a header and a body. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
The header is mandatory and the body is optional. The scope of the header is also optional.
Header
The header must be a short (72 characters or less) summary of the changes made.
Type
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- revert: Reverts a previous commit
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
Revert
If the commit reverts a previous commit, it should begin with revert: ,
followed by the header of the reverted commit. In the body it should say:
Revert commit <hash>., where the hash is the SHA of the commit being reverted.
Scope
The scope could be anything specifying place of the commit change. For example
$location, $browser, $compile, $rootScope, ngHref, ngClick,
ngView, etc.
Subject
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
A properly formed git commit subject line should always be able to complete the following sentence:
If applied, this commit will your subject line here
Body
Wrap the body at 72 characters whenever possible (for example, don't modify long links to follow this rule). Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The body contains (in order of appearance):
- A detailed description of the committed changes.
- References to GitHub issues that the commit closes (e.g.,
Closes #000orFixes #000). - Any breaking changes.
Include every section of the body that is relevant for your commit.
Breaking changes should start with the phrase BREAKING CHANGE: with a
space or two newlines. The rest of the commit message is then used for this.
Git config
Not a requirement, just a friendly tip. 😉
It's nice when commits are being GPG-signed. Github has a few articles about configuring & signing.
https://help.github.com/articles/signing-commits-using-gpg/
And tl;dr version:
gpg --gen-key
gpg --send-keys <your generated key ID>
git config --global commit.gpgsign true
Coding Guidelines
Use C++11.
Coding style
function()
{
1st_line;
2nd_line;
}
// if / while / for / switch
if ()
1_line;
else if ()
just_one_line;
else
each_condition;
// ↑ note space between last line of conditional code, and code outside of condition
if ()
{
1_line;
}
else if ()
{
what_if;
i_told_you;
}
else
{
that_there_are;
more_lines;
}
QObject* asterisksGoWithTheType;
uint8_t* array = new uint8_t[count];
// camelCase for variables, CamelCase for classes
QObject notToMentionThatWeUseCamelCase;
E.g. https://github.com/tux3/qTox/blob/master/src/misc/flowlayout.cpp
No translatable HTML tags
Do not put HTML in UI files, or inside tr(). Instead, you can put put it in
C++ code in the following way, to make only user-facing text translatable:
someWidget->setTooltip(
QStringLiteral("<html><!-- some HTML text -->") + tr("Translatable text…") +
QStringLiteral("</html>");
Limitations
Filesystem
Windows' unbeaten beauty and clarity:
https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247%28v=vs.85%29.aspx
Symbols that should be forbidden for filenames under Windows:
< > : " / \ | ? *