Skip to content

Commit 8a14200

Browse files
authored
docs(stdlib/contrib): add docs on how to contribute third party packages (#2775)
1 parent f3f49c9 commit 8a14200

File tree

4 files changed

+38
-9
lines changed

4 files changed

+38
-9
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,12 @@ This is done by running `go generate` in the following way.
7272
$ go generate ./stdlib
7373
```
7474

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).
79+
uu
80+
7581
## Pull request guidelines
7682

7783
### Effective Go

docs/new_flux_ideas_and_guide.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
11
# Getting Started Querying with Flux and InfluxDB
2-
**NOTE BEFORE YOU GET STARTED:** Forget much of what you know about Flux. This is a new version with some very
3-
important differences. As you work through this guide, please keep notes on your thoughts for each section
4-
as you encounter it. This ends in a test and you are expected to create a secret Gist with your thoughts and
5-
the answers to the questions. You can close with a summary of your feelings after going through the whole thing
6-
but please note your thoughts as you go along. It's very likely that you'll think something is crazy or off
7-
initially, but maybe think it's ok when you look back later to write your summary. We're interested in
8-
seeing this progression of your learning and thought process.
9-
10-
You're allowed to ask questions in the private channel set up for this usability test in Slack. #flux-usability-yourname
112

123
Welcome to the getting started guide for Flux. Flux is a functional scripting and query language that looks
134
very similar to Javascript in some parts, but with shortcut syntax for common queries. Its goal is to make

stdlib/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,8 @@ All `*_test.flux` files are encoded into `flux_test_gen.go` the non test `.flux`
4242
> 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.
4343
This enables downstream projects that import Flux to run the test suite define in the standard library against their implementation.
4444

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.

stdlib/contrib/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contribute Third Party Flux Packages
2+
3+
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.
27+

0 commit comments

Comments
 (0)