Skip to content

Commit 95f2d70

Browse files
contributing: edits for clarity
Signed-off-by: Alexa Kreizinger <[email protected]>
1 parent 8d98e1a commit 95f2d70

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

CONTRIBUTING.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ and close the pull request if we don't hear back from you.
4747

4848
## Submit a contribution
4949

50+
When you open a pull request, make your changes against `master`, which is the
51+
active development branch. If your contribution also applies to the latest
52+
stable version, submit another PR for that versioned branch. However, if
53+
submitting multiple PRs at the same time adds too much complexity, you can instead
54+
create a single PR against `master` and specify that your changes need to be
55+
**backported** to other branches; one of our maintainers will take care of that
56+
process on your behalf.
57+
5058
All contributions must be made **first** against [master branch](https://github.com/fluent/fluent-bit-docs/tree/master) which is the active development branch, and then **if** the contribution also applies for the current stable branch, submit another PR for that specific branch, if submitting another PR adds some complexity, please specify in the first PR as a comment (for master branch) that it needs to be *backported*. One of our maintainers will take care of that process.
5159

5260
As a contributor, we'll ask you to follow a few best practices related to Git:
@@ -87,7 +95,8 @@ error and prevent your pull request from merging.
8795
To prevent DCO errors, refer to the following guide about
8896
[signing your commits properly](https://github.com/src-d/guide/blob/master/developer-community/fix-DCO.md).
8997

90-
> :bulb: For faster signing, you can use the `-s` flag in Git:<br>
98+
> :bulb: For faster signing, you can use the `-s` flag in Git:
99+
>
91100
> `git commit -a -s -m "pipeline: outputs: syslog: fix grammar in examples"`
92101
93102
## Style guidelines
@@ -98,10 +107,6 @@ for most topics related to grammar, style, and formatting. We don't expect you
98107
to memorize these style rules, but the technical writer who reviews your pull
99108
request may suggest changes accordingly.
100109

101-
### Line wrap
102-
103-
[TBD]
104-
105110
### Vale
106111

107112
The Fluent Bit maintainers are working to add a [Vale](https://vale.sh/docs/) plugin

0 commit comments

Comments
 (0)