Development Guidelines: Difference between revisions
Jump to navigation
Jump to search
(A quick draft for the development guidelines. Please feel free to add stuff.) |
(Common GPL header for LinuxBIOS -- example.) |
||
Line 20: | Line 20: | ||
== License Issues == | == License Issues == | ||
* Contributed code must be GPL'd (preferrably GPLv2 or any later version), or at least have a GPL-compatible license. | * Contributed code must be GPL'd (preferrably GPLv2 or any later version), or at least have a GPL-compatible license. | ||
=== Common License Header === | |||
Example: | |||
/* | |||
* This file is part of LinuxBIOS, a Free Software BIOS implementation. | |||
* | |||
* Copyright (C) 2003-2005 John Doe <john@example.com> | |||
* Copyright (C) 2006 Jane Doe <jane@example.com> | |||
* | |||
* This program is free software; you can redistribute it and/or modify | |||
* it under the terms of the GNU General Public License as published by | |||
* the Free Software Foundation; either version 2 of the License, or | |||
* (at your option) any later version. | |||
* | |||
* This program is distributed in the hope that it will be useful, | |||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
* GNU General Public License for more details. | |||
* | |||
* You should have received a copy of the GNU General Public License | |||
* along with this program; if not, write to the Free Software | |||
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |||
*/ |
Revision as of 00:27, 20 October 2006
This is work in progress.
Development Environment
- Required toolchains etc.
Coding Guidelines
General Guidelines
Comments
Coding Style
- Indentation etc.
Documentation
- General guidelines and tips
- Doxygen
Testing
- abuild
Svn Commits
- Send patches to the Mailinglist for review before committing.
- Patch from: XYZ
- Signed off by: XYZ
Bug-Tracker
License Issues
- Contributed code must be GPL'd (preferrably GPLv2 or any later version), or at least have a GPL-compatible license.
Common License Header
Example:
/* * This file is part of LinuxBIOS, a Free Software BIOS implementation. * * Copyright (C) 2003-2005 John Doe <john@example.com> * Copyright (C) 2006 Jane Doe <jane@example.com> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */