1,847
edits
Contribute: Difference between revisions
Jump to navigation
Jump to search
m
Siko1056 moved page Contribution guidelines to Contribute
m (→Coding style: Merge C and C++, same guide anyway.) |
m (Siko1056 moved page Contribution guidelines to Contribute) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
== Bug reports and patch submission == | == Bug reports and patch submission == | ||
Bugs and patches should be submitted to Octave's | * Bugs and patches should be submitted to Octave's [https://savannah.gnu.org/bug/?func=additem&group=octave bug] and [https://savannah.gnu.org/patch/?func=additem&group=octave patch] trackers respectively. | ||
[https://savannah.gnu.org/bug/?func=additem&group=octave bug] and | |||
[https://savannah.gnu.org/patch/?func=additem&group=octave patch] | |||
trackers respectively. | |||
The best way to contribute patches is to create a Mercurial changeset. | * The best way to contribute patches is to create a Mercurial changeset. | ||
** Learn how to use [[Mercurial]]. | |||
** [[Commit message guidelines]]. | |||
== | === Contributor Agreement === | ||
By submitting patches to this project, you agree to the following conditions: | |||
* Your contribution will be released under the terms of the GNU GPL, version 3 or any later version. | |||
* Your contribution must be an independent work or derived from code that may be released under the terms of the GPL. '''Under no circumstances may it be based on code from Matlab or other non-free code that you may have access to view'''. | |||
* In the Octave source code, all files are marked with a copyright statement that says "Copyright (C) YYYY-YYYY The Octave Project Developers". This copyright notice is used to ease the burden of maintaining copyright information in the source files, not to diminish or remove credit for contributions. Detailed information about what changes have been made and who has made them is maintained in the revision history of the Octave sources. | |||
* If you wish, you will be credited as a contributor in the Octave documentation. | |||
== Building from development sources == | |||
:''See [[Building]].'' | |||
== Coding style == | == Coding style == | ||
| Line 27: | Line 27: | ||
Apart from C++ and Octave language (m-files), Octave's sources include | Apart from C++ and Octave language (m-files), Octave's sources include | ||
files written in C, Fortran, M4, Perl, Unix shell, AWK, Texinfo, and | files written in C, Fortran, M4, Perl, Unix shell, AWK, Texinfo, and | ||
TeX. There are not many rules to follow when using these other | |||
languages; some of them are summarized below. In any case, the golden | languages; some of them are summarized below. In any case, the golden | ||
rule is: if you modify a source file, try to follow any conventions you | rule is: if you modify a source file, try to follow any conventions you | ||
| Line 34: | Line 34: | ||
=== C/C++ guide === | === C/C++ guide === | ||
See [[C++ style guide]]. For C, you should follow all C++ rules that can apply. | :''See [[C++ style guide]]. For C, you should follow all C++ rules that can apply.'' | ||
=== Octave guide === | === Octave guide === | ||
See [[Octave style guide]]. | :''See [[Octave style guide]].'' | ||
=== Help text style === | === Help text style === | ||
:''See [[Help text style guide]].'' | |||
See [[Help text]]. | |||
=== Fortran guide === | === Fortran guide === | ||
If you modify a Fortran file, you should stay within Fortran 77 with | If you modify a Fortran file, you should stay within Fortran 77 with | ||
common extensions like {{codeline|END DO}}. Currently, we want all sources | common extensions like {{codeline|END DO}}. Currently, we want ensure that | ||
it is possible to compile all sources with the gfortran compiler, without | |||
possible. This usually means that non-legacy compilers also accept the | special flags if possible. This usually means that non-legacy compilers | ||
sources. | also accept the sources. | ||
=== M4 guide === | === M4 guide === | ||
| Line 60: | Line 59: | ||
[https://www.gnu.org/software/autoconf-archive/ Autoconf archive]. | [https://www.gnu.org/software/autoconf-archive/ Autoconf archive]. | ||
=== | === Wiki guide === | ||
* Please try to fit a new page into the already existing category tree. | * Please try to fit a new page into the already existing category tree. | ||