-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Contributing refers to example-specific content.
- Loading branch information
François Garillot
committed
Apr 3, 2017
1 parent
0d7ff19
commit ed1aa25
Showing
3 changed files
with
47 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,18 @@ | ||
## Contribute | ||
|
||
1. Check for open issues, or open a new issue to start a discussion around a | ||
new example or a bug. | ||
2. If you feel uncomfortable or uncertain about an issue or your changes, feel free to contact us on Gitter using the link above. | ||
3. Fork [the repository](https://github.com/deeplearning4j/dl4j-examples.git) on GitHub to start making your changes to the **master** branch (or branch off of it). | ||
4. If you're providing a new example, please help reference it by adding notes | ||
of relevant publications to the code comments, including links if | ||
available. If you fix an existing example, write a test, which shows that the bug was fixed or that the feature works as expected. | ||
5. Note the repository follows | ||
the [Google Java style](https://google.github.io/styleguide/javaguide.html) | ||
with two modifications: 120-char column wrap and 4-spaces indentation. You | ||
can format your code to this format by typing `mvn formatter:format` in the | ||
subproject you work on, by using the `contrib/formatter.xml` at the root of | ||
the repository to configure the Eclipse formatter, or by [using the INtellij | ||
plugin](https://github.com/HPI-Information-Systems/Metanome/wiki/Installing-the-google-styleguide-settings-in-intellij-and-eclipse). | ||
|
||
6. Send a pull request, and bug us on Gitter until it gets merged and published. |
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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
#### Issue Description | ||
|
||
Please describe your issue, along with: | ||
- expected behavior | ||
- encountered behavior | ||
|
||
#### Version Information | ||
|
||
Please indicate relevant versions, including, if relevant: | ||
|
||
* Deeplearning4j version | ||
* platform information (OS, etc) | ||
* CUDA version, if used | ||
* NVIDIA driver version, if in use | ||
|
||
#### Contributing | ||
|
||
If you'd like to help us fix the issue by contributing some code, but would | ||
like guidance or help in doing so, please mention it! |
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 |
---|---|---|
@@ -0,0 +1,10 @@ | ||
## What changes were proposed in this pull request? | ||
|
||
(Please fill in changes proposed in this fix) | ||
|
||
## How was this patch tested? | ||
|
||
(Please explain how this patch was tested. E.g. unit tests, integration tests, manual tests) | ||
|
||
Please review | ||
https://github.com/deeplearning4j/deeplearning4j/blob/master/CONTRIBUTING.md before opening a pull request. |