Skip to content

Commit 9b20bf1

Browse files
Create CONTRIBUTING.md
1 parent 2804618 commit 9b20bf1

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Flux.jl and the Flux ecosystem follow the [ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac). For best practices on getting started, check out that document.
2+
3+
We also suggest taking a look at the [Julia Ecosystem contributing guide](https://julialang.org/contribute/) which goes over higher level topics like why you should contribute, different contribution pathways, and more!
4+
5+
## Help Wanted Issues
6+
7+
One of the best ways to contribute is by looking at issues labeled ["help wanted"](https://github.com/FluxML/Flux.jl/labels/help%20wanted). These issues are not always very beginner friendly but you are welcome to ask clarifying questions or just browse them to see if there is anything that seems interesting to help with.
8+
9+
## Good First Issues
10+
11+
While there are not many right now, we do have a section for ["good for issues"](https://github.com/FluxML/Flux.jl/labels/good%20first%20issue). As mentioned above, if any of these seem interesting but there is no clear next step in your mind, please feel free to ask for a suggested step. Often times in open source, issues labeled as "good first issue" actually take some back and forth between maintainers and contributors before the issues is ready to be tackled by a new contributor.
12+
13+
## Model Zoo
14+
15+
If you are already using Flux to develop models, one way to give back to the community is by sharing models you have created in the [Model Zoo](https://github.com/FluxML/model-zoo). You can find out more in the [Model Zoo's README](https://github.com/FluxML/model-zoo#contributing).
16+
17+
## Write Tutorials
18+
19+
Tutorials are an important part of making Deep Learning and Flux accessible to everyone. We already have some great ones on our website here: https://fluxml.ai/tutorials.html and welcome new ones, especially if they are beginner focused, of which beginners tend to write the best ones. A good first step is to find a tutorial you find helpful from another ecosystem and try to rewrite it using Flux (making sure to properly attribute and not plagiarize)
20+
21+
## Other ideas
22+
23+
We are open to contributions in all shapes and forms! If you have an idea, please suggest it and we will do our best to help you bring it to life!

0 commit comments

Comments
 (0)