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
+21-9Lines changed: 21 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -657,8 +657,8 @@ Distributable packages can be found in `target/` after the build completes.
657
657
Kibana documentation is written in [asciidoc](http://asciidoc.org/) format in
658
658
the `docs/` directory.
659
659
660
-
To build the docs, you must clone the [elastic/docs](https://github.com/elastic/docs)
661
-
repo as a sibling of your kibana repo. Follow the instructions in that project's
660
+
To build the docs, clone the [elastic/docs](https://github.com/elastic/docs)
661
+
repo as a sibling of your Kibana repo. Follow the instructions in that project's
662
662
README for getting the docs tooling set up.
663
663
664
664
**To build the Kibana docs and open them in your browser:**
@@ -676,14 +676,26 @@ node scripts/docs.js --open
676
676
677
677
Part of this process only applies to maintainers, since it requires access to GitHub labels.
678
678
679
-
Kibana publishes [Release Notes](https://www.elastic.co/guide/en/kibana/current/release-notes.html) for major and minor releases. To generate the Release Notes, the writers run a script against this repo to collect the merged PRs against the release.
680
-
To include your PRs in the Release Notes:
679
+
Kibana publishes [Release Notes](https://www.elastic.co/guide/en/kibana/current/release-notes.html) for major and minor releases. The Release Notes summarize what the PRs accomplish in language that is meaningful to users. To generate the Release Notes, the team runs a script against this repo to collect the merged PRs against the release.
681
680
682
-
1. In the title, summarize what the PR accomplishes in language that is meaningful to the user. In general, use present tense (for example, Adds, Fixes) in sentence case.
683
-
2. Label the PR with the targeted version (ex: `v7.3.0`).
684
-
3. Label the PR with the appropriate GitHub labels:
681
+
#### Create the Release Notes text
682
+
The text that appears in the Release Notes is pulled directly from your PR title, or a single paragraph of text that you specify in the PR description.
683
+
684
+
To use a single paragraph of text, enter `Release note:` or a `## Release note` header in the PR description, followed by your text. For example, refer to this [PR](https://github.com/elastic/kibana/pull/65796) that uses the `## Release note` header.
685
+
686
+
When you create the Release Notes text, use the following best practices:
687
+
* Use present tense.
688
+
* Use sentence case.
689
+
* When you create a feature PR, start with `Adds`.
690
+
* When you create an enhancement PR, start with `Improves`.
691
+
* When you create a bug fix PR, start with `Fixes`.
692
+
* When you create a deprecation PR, start with `Deprecates`.
693
+
694
+
#### Add your labels
695
+
1. Label the PR with the targeted version (ex: `v7.3.0`).
696
+
2. Label the PR with the appropriate GitHub labels:
685
697
* For a new feature or functionality, use `release_note:enhancement`.
686
-
* For an external-facing fix, use `release_note:fix`. Exception: docs, build, and test fixes do not go in the Release Notes. Neither fixes for issues that were only on `master` and never have been released.
698
+
* For an external-facing fix, use `release_note:fix`. We do not include docs, build, and test fixes in the Release Notes, or unreleased issues that are only on `master`.
687
699
* For a deprecated feature, use `release_note:deprecation`.
688
700
* For a breaking change, use `release_note:breaking`.
689
701
* To **NOT** include your changes in the Release Notes, use `release_note:skip`.
@@ -695,7 +707,7 @@ We also produce a blog post that details more important breaking API changes in
695
707
696
708
## Name the feature with the break (ex: Visualize Loader)
697
709
698
-
Summary of the change. Anything Under `#Dev Docs` will be used in the blog.
710
+
Summary of the change. Anything Under `#Dev Docs` is used in the blog.
Specifies directory names that can be imported by other ui-plugins built using the same instance of the @<!---->kbn/optimizer. A temporary measure we plan to replace with better mechanisms for sharing static code between plugins
0 commit comments