Skip to content

Commit a22e6a7

Browse files
committed
Put section Flux source code organization back
1 parent 0eb17de commit a22e6a7

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ In this section, you can find information on the following:
121121

122122
* [How to file a bug report](#how-to-file-a-bug-report)
123123
* [How to submit a contribution](#how-to-submit-a-contribution)
124+
* [Flux source code organisation](#flux-source-code-organisation)
124125

125126
### How to file a bug report
126127

@@ -143,3 +144,14 @@ When filing the bug report, provide the following information (if applicable):
143144
### How to submit a contribution
144145

145146
You can use [this template](https://github.com/FluxML/Flux.jl/blob/master/.github/pull_request_template.md) as a starting point when creating a new pull request.
147+
148+
### Flux source code organization
149+
150+
The following table shows how the Flux code is organized:
151+
152+
| Directory | Contents |
153+
| ------------- | ------------- |
154+
| docs | Documentation site |
155+
| paper | Paper that describes Flux |
156+
| src | Source for Flux |
157+
| test | Test suites |

0 commit comments

Comments
 (0)