|
Revision 1923, 0.7 kB
(checked in by karpet, 1 year ago)
|
expose the tokenizer into Perl space for benchmarking
|
| Line | |
|---|
| 1 |
This file documents some conventions for contributing code to the project. |
|---|
| 2 |
|
|---|
| 3 |
1. Diffs are welcome. Use 'diff -u' format. |
|---|
| 4 |
|
|---|
| 5 |
2. Naming conventions: |
|---|
| 6 |
|
|---|
| 7 |
* all public functions and structs are prefixed with 'swish_' |
|---|
| 8 |
* all functions are lower_case_with_underscore() |
|---|
| 9 |
* all structs are CamelCased |
|---|
| 10 |
|
|---|
| 11 |
3. If the function/struct is public (i.e. call-able via the library) |
|---|
| 12 |
then it must be documented in doc/libswish3.3.pod. |
|---|
| 13 |
|
|---|
| 14 |
4. If the function/struct is not public, make it 'static'. If it can't be static |
|---|
| 15 |
(i.e., used in more than one .c file), then it is public. So prefix it with swish_ |
|---|
| 16 |
and document it. |
|---|
| 17 |
|
|---|
| 18 |
5. Add comments in the code per the existing examples. |
|---|
| 19 |
|
|---|
| 20 |
6. Test cases are required. See src/test.pl for an example. |
|---|
| 21 |
|
|---|
| 22 |
|
|---|
| 23 |
|
|---|
