You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,6 +72,12 @@ This is done by running `go generate` in the following way.
72
72
$ go generate ./stdlib
73
73
```
74
74
75
+
### Contributing Flux Packages
76
+
77
+
If you have some Flux code that you think the wider community would benifit from please consider contributing it to the Flux repo.
78
+
We have layed out specific guildines in the contrib [README](https://github.com/influxdata/flux/blob/master/stdlib/contrib/README.md).
Copy file name to clipboardExpand all lines: stdlib/README.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,3 +42,8 @@ All `*_test.flux` files are encoded into `flux_test_gen.go` the non test `.flux`
42
42
> NOTE: The `flux_test_gen.go` file is not a Go test file as we want to include the Flux test code into the normal build.
43
43
This enables downstream projects that import Flux to run the test suite define in the standard library against their implementation.
44
44
45
+
46
+
## Third Party Contributions
47
+
48
+
We collect third part contributions into the `contrib` package.
49
+
See the [README](https://github.com/influxdata/flux/blob/master/stdlib/contrib/README.md) for details on how to contribute a third party package to Flux.
This directory contains a collections of third party contributions to Flux.
4
+
This is a simple and light weight process for sharing Flux code with the wider community while no other official means of sharing Flux packages exists.
5
+
6
+
## Adding a New Package
7
+
8
+
To add a new package first create a new directory using your github account name.
9
+
Then create another directory for the name of your package.
10
+
11
+
For example if I (@nathanielc) wanted to add a Flux package about reading text based ledger files in Flux I would create a directory named `nathanielc/ledger` under the `contrib` directory.
12
+
I would then place all the Go code, Flux code and corresponding test cases into that directory.
13
+
14
+
Please see the [CONTRIBUTING](https://github.com/influxdata/flux/blob/master/CONTRIBUTING.md) guide for more details on how to make contributions to the Flux repo.
15
+
16
+
## Package Ownership
17
+
18
+
Packages in the `contrib` directory are owned and maintained by their author not the InfluxData team.
19
+
As such the author will be requested for review on all changes to the package.
20
+
21
+
22
+
## Future Plans
23
+
24
+
In the future we may create a more official repository of Flux packages that does not require committing the code to the Flux code repository.
25
+
When that happens we intend to promote the packages from the `contrib` directory into their own Flux package in that repository in what ever form that takes.
26
+
Until then we will collect third party packages into the `contrib` directory.
0 commit comments