Warning, /graphics/spectacle/CONTRIBUTING is written in an unsupported language. File is not indexed.
0001 COMMIT POLICY 0002 0003 Everybody is welcome to committing small fixes and one-liners 0004 without prior notification to the maintainer, provided that the 0005 following rules are followed: 0006 0007 1. Please keep your commits as small and as atomic as possible. 0008 2. Do not push both formatting and code changes in the same 0009 commit. 0010 3. Do not fix coding style and code issues in the same commit. 0011 0012 For larger commits, please use Gitlab or send 0013 and e-mail to the maintainer. A rule of thumb to check whether your 0014 commit is a major commit is if it affects more than 5 lines of code. 0015 0016 Break down larger fixes into smaller commits. Even if you push the 0017 commits with one "git push", git preserves your commit info. 0018 0019 i18n and documentation fixes, however large they are, may be directly 0020 committed without prior notification. 0021 0022 CODING STYLE 0023 0024 Spectacle follows the KDELibs coding style, with a few exceptions: 0025 0026 1. In class definitions, access modifiers are aligned along with 0027 member declarations, i.e., at one level right. E.g.: 0028 0029 class Hello : public QObject 0030 { 0031 Q_OBJECT 0032 0033 public: 0034 0035 void function(); 0036 } 0037 0038 The access modifier ordering is: public, signals, public slots, 0039 protected slots, protected, private slots, private. Member variables 0040 come at the end, after all member functions. This is not strictly 0041 enforced, but is a good rule to follow. 0042 0043 2. Member variables follow the format mCamelCase, and not m_camelCase 0044 which is more common throughout the rest of the KDE Applications 0045 0046 3. Source files are mixed case, named the same as the class they 0047 contain. i.e., SomeClass will be defined in SomeClass.cpp, not 0048 someclass.cpp 0049 0050 Happy coding!