diff --git a/CONTRIBUTING b/CONTRIBUTING index 7bb93d8..3f86325 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -1,50 +1,50 @@ COMMIT POLICY Everybody is welcome to committing small fixes and one-liners without prior notification to the maintainer, provided that the following rules are followed: 1. Please keep your commits as small and as atomic as possible. 2. Do not push both formatting and code changes in the same commit. 3. Do not fix coding style and code issues in the same commit. -For larger commits, please use Phabricator or send +For larger commits, please use Gitlab or send and e-mail to the maintainer. A rule of thumb to check whether your commit is a major commit is if it affects more than 5 lines of code. Break down larger fixes into smaller commits. Even if you push the commits with one "git push", git preserves your commit info. i18n and documentation fixes, however large they are, may be directly committed without prior notification. CODING STYLE Spectacle follows the KDELibs coding style, with a few execptions: 1. In class definitions, access modifiers are aligned along with member declarations, i.e., at one level right. E.g.: class Hello : public QObject { Q_OBJECT public: void function(); } The access modifier ordering is: public, signals, public slots, protected slots, protected, private slots, private. Member variables come at the end, after all member functions. This is not strictly enforced, but is a good rule to follow. 2. Member variables follow the format mCamelCase, and not m_camelCase which is more common throughout the rest of the KDE Applications 3. Source files are mixed case, named the same as the class they contain. i.e., SomeClass will be defined in SomeClass.cpp, not someclass.cpp Happy coding! diff --git a/README b/README index 354baac..3f54d0e 100644 --- a/README +++ b/README @@ -1,33 +1,33 @@ Spectacle - The KDE Screenshot Utility Spectacle is screenshot taking utility for the KDE desktop. Spectacle can also be used in non-KDE X11 desktop environments. Contributing ************ Spectacle is developed under the KDE umbrella and uses KDE infrastructure for development. Please see the file CONTRIBUTING for details on coding style and how to contribute patches. Please note that pull requests on GitHub aren't supported. The recommended way of contributing patches is via KDE's -instance of phabricator at https://phabricator.kde.org/ +instance of gitlab at https://invent.kde.org/graphics/spectacle. Release Schedule **************** -Spectacle is released as part of the KDE Applications suite and has three +Spectacle is released by KDE's release service and has three major releases every year. They are numbered YY.MM, where YY is the two- digit year and MM is the two-digit month. Major releases are made in April, August and December every year. The Spectacle version follows the KDE -Applications release version. +release service version. Reporting Bugs ************** Please report bugs at KDE's Bugzilla, available at https://bugs.kde.org/ For discussions, the #kde-devel IRC channel and the kde-devel mailing list are good places to post.