-
Notifications
You must be signed in to change notification settings - Fork 751
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Made grammatical/stylistic changes. Dramatically improved the Italian.
- Loading branch information
Showing
1 changed file
with
26 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,52 +1,39 @@ | ||
| #Contributing guidelines | ||
| | ||
| ##How to contribute to MatConvNet | ||
|
|
||
| Please read first the | ||
| [Developers notes](http://www.vlfeat.org/matconvnet/developers/) on the | ||
| MatConvNet website which describes the library structure. | ||
| For a description of how the library is structured, take a look at the [Developers notes](http://www.vlfeat.org/matconvnet/developers/) on the MatConvNet website. | ||
|
|
||
| ###Contributor Oath (optional) | ||
| | ||
| Before you can apply your patches directly in all their might, you must solemnly | ||
| swear your allegiance to MatConvNet by taking the MatConvNet Oath. This is done | ||
| through a formal ceremony that takes place once a year at a secret location on | ||
| the eastern shores of Sicily. At the ceremony (inconveniently only held at the | ||
| sunset of the summer solstice) you must recite the following passage from | ||
| memory in a guttural chant: | ||
|
|
||
| ``` | ||
| Giuro solennemente di contribuire solo le richieste git pull | ||
| che raccontano un ambiente pulito, storia avvincente di un | ||
| miglioramento MatConvNet. | ||
| ``` | ||
| | ||
| This oath is both legally and illegally binding. Each oath taker will receive | ||
| write-access permissions to the GitHub repository, together with a stylish | ||
| MATLAB branded cloak. | ||
| Before you can apply your patches directly in all their might, you must solemnly swear your allegiance to MatConvNet by taking the MatConvNet Oath. This is done through a formal ceremony that takes place once a year at a secret location on the eastern shores of Sicily. At the ceremony (inconveniently held at sunset on the eve of the summer solstice) you must recite the following passage from memory in a guttural chant: | ||
|
|
||
|
|
||
| *Giuro solennemente davanti a tutti gli dei del computer che manderò solo le richieste di <br> | ||
| git pull che rendano MatConvNet la miglior libreria di apprendimento approfondito del mondo.* | ||
|
|
||
| This oath is both legally and illegally binding. Each oath taker will receive write-access permissions to the GitHub repository, together with a stylish MATLAB branded cloak. | ||
|
|
||
| ###Issues | ||
| We are happy for any reported issues which help to remove bugs and generally | ||
| improve the quality of the library. Issues are most useful when reporting bugs, | ||
| unexpected crashes, discussing library design decisions or feature requests. | ||
| We are grateful for any reported issues which help to remove bugs and improve the overall quality of the library. In particular, you can use the issue tracker to: | ||
|
|
||
| * report bugs and unexpected crashes | ||
| * discuss library design decisions | ||
| * request new features | ||
|
|
||
| In case of reporting a bug, in order to resolve it, it is useful to know the following: | ||
| * What steps are needed to reproduce the issue | ||
| * MATLAB, compiler and CUDA version, where appropriate | ||
|
|
||
| Also, it is useful if you can make sure that the bug is reproducible on the | ||
| latest master. | ||
| When reporting bugs, it really helps if you can provide the following: | ||
|
|
||
| The most difficult bugs to remove are those which cause crashes of the core | ||
| functions (e.g. CUDA errors etc.). In those cases, it is really useful to create | ||
| a *minimal example* which is able to reproduce the issue. We know that this may | ||
| mean a bit of work, but it helps to remove the bug more quickly. | ||
| * Which steps are needed to reproduce the issue | ||
| * MATLAB, compiler and CUDA version (where appropriate) | ||
|
|
||
| Before opening an issue to report a bug, please make sure that the bug is reproducible on the latest version of the master branch. | ||
|
|
||
| The most difficult bugs to remove are those which cause crashes of the core functions (e.g. CUDA errors etc.). In those cases, it is really useful to create a *minimal example* which is able to reproduce the issue. We know that this may mean a bit of work, but it helps us to remove the bug more quickly. | ||
|
|
||
| ###Pull requests | ||
| The quickest way how we can accept a Pull request is when it is done against | ||
| the `devel` branch. As we try to keep the `master` branch to be the latest | ||
| release version with necessary bug-fixes. | ||
| Please make any Pull Requests against the `devel` branch rather than the `master` branch which is maintained as the latest stable release of the library. | ||
|
|
||
| As a general rule, it is much easier to accept small Pull Requests that make a single improvement to the library than complex code changes that affect multiple parts of the library. When submitting substantial changes, it is useful if unit tests are provided with the code. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| It is also much easier to accept a small Pull Requests with a single improvement | ||
| of the library. In case of more substantial changes, it is useful if a unit | ||
| test is included as well. |