KDE Frameworks/Getting Started: Difference between revisions
(→Build And Run: make wording match the title) |
(reword the first section, remove the "using the software" section (no need to labour the point)) |
||
| Line 6: | Line 6: | ||
==Introduction== | ==Introduction== | ||
There are many different ways to become [http://community.kde.org/Get_Involved involved in the KDE Community], | There are many different ways to become [http://community.kde.org/Get_Involved involved in the KDE Community], starting with simply using our software. This guide is to help you get started on the technical side of developing the software itself. | ||
{{Note|1=If you just want to use stable KDE Software for your everyday computing needs, then you do not usually need to build KDE Software for yourself. See [https://www.kde.org/download/ Getting KDE Software] for information about how to get hold of the software for your system.}} | |||
If you | It is important to note that the version of KDE Software that is provided by your distribution or downloaded via an installer is ''not'' the same as the version that is being worked on by software developers. If you are using KDE CoolApp 3.2, the developers are working on is the development version, usually called "KDE CoolApp ''master''". This is the version that will become KDE CoolApp 3.3, or maybe 4.0. If you want to get involved in developing KDE Software, you will need to get hold of and build the development versions. | ||
This guide will aim to show you how to build, run and help improve the development versions of KDE Software. We will primarily be looking at submitting a ''patch'' to change the software, but the information here is also useful if you want to [https://techbase.kde.org/Contribute/Bugsquad test whether a bug still exists in the software], for example. | |||
If you just want to | If you just want to get started building the code then you can skip to the [[Special:myLanguage/KF5/Getting_Started/Build|build instructions]], but it is recommended you first understand the background material presented here. | ||
== Getting Help == | == Getting Help == | ||
Revision as of 16:21, 23 August 2015
| Under Construction |
|---|
| This is a new page, currently under construction! |
Introduction
There are many different ways to become involved in the KDE Community, starting with simply using our software. This guide is to help you get started on the technical side of developing the software itself.
It is important to note that the version of KDE Software that is provided by your distribution or downloaded via an installer is not the same as the version that is being worked on by software developers. If you are using KDE CoolApp 3.2, the developers are working on is the development version, usually called "KDE CoolApp master". This is the version that will become KDE CoolApp 3.3, or maybe 4.0. If you want to get involved in developing KDE Software, you will need to get hold of and build the development versions.
This guide will aim to show you how to build, run and help improve the development versions of KDE Software. We will primarily be looking at submitting a patch to change the software, but the information here is also useful if you want to test whether a bug still exists in the software, for example.
If you just want to get started building the code then you can skip to the build instructions, but it is recommended you first understand the background material presented here.
Getting Help
If you are looking for help in using KDE Plasma or KDE Applications then please visit the KDE UserBase.
If you have any questions or problems with building or developing KDE Software please feel free to ask for help. The IRC channel #kde-devel is recommended as the best source of general help. For application-specific help please try the application's own mailing list or IRC channel.
Be patient while waiting for a response, and try to work through the problem yourself: we aren't going to do it all for you. Working your way through and understanding why something doesn't work is a good way to learn how to do things the right way.
Development Policies
KDE Software is a very large, diverse and complex code base and the KDE Community community has developed many policies and processes to make the KDE Software development process a lot easier. These are documented elsewhere in TechBase and you should try to familiarise yourself with them over time. You should also learn any specific contribution guidelines for the application that you might be working on.
Don't feel you have to read through every single KDE policy before you even send your first patch. Start with the manifesto and the code of conduct; these are the basis for interacting with the KDE Community in general. When it comes to contributing code, the most important thing to get right is how to send your contribution (see the section about contributing). Maintainers and other contributors will be more familiar with the technical policies, and will help you make your contribution adhere to them while you are still starting out.
- The KDE Community Manifesto that all KDE Projects follow
- The KDE Community Code of Conduct that all KDE Community members must adhere to
- Development Policies and Procedures to follow
- The KDE Software Engineering Framework
- The development lifecycle for a new application
- The KDE Release Schedule
Build And Run
The following sections explain the steps you need to successfully build and run KDE Software from source:
- How the KDE Software source code is structured
- How to Build and Install KDE Software
- Development Tools useful in developing KDE Software
Contributing
Once you have a copy of KDE Software built you can then start contributing code back to the KDE Community. The pages below will help you find out how you can help make KDE Software even better.