Skip to content

Commit ef61d73

Browse files
authored
Update readme contributing (#40)
* Update Contributing Signed-off-by: Gerald Venzl <gerald.venzl@oracle.com> * Update Contributing Signed-off-by: Gerald Venzl <gerald.venzl@oracle.com> --------- Signed-off-by: Gerald Venzl <gerald.venzl@oracle.com>
1 parent 360bb6d commit ef61d73

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,14 @@ If you find an issue to work on, you are welcome to open a PR with a fix.
2323

2424
### Make Changes
2525

26-
All source pages are organized in the [features](features) folder.
27-
All files are in [AsciiDoc](https://asciidoc.org/) format, see the [AsciiDoc Syntax Quick Reference](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/) for more information on the syntax.
26+
All source pages are organized in the [features](features) folder and are in [AsciiDoc](https://asciidoc.org/) format.
27+
28+
New features can be organized into subfolders **not starting with `_`** inside the [features](features).
29+
30+
To contribute a new feature to this page, add a new [AsciiDoc](https://asciidoc.org/) (`*.adoc`) file into the [features](features) folder or a sub folder.
31+
You can find an AsciiDoc template [feature.adoctemplate](features/feature.adoctemplate) in the [features](features) folder.
32+
33+
For more information about the AsciiDoc syntax, see the [AsciiDoc Syntax Quick Reference](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/).
2834

2935
#### Make changes in the UI
3036

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,7 @@
22

33
## Contributing
44

5-
To contribute a feature to this page, add a new [AsciiDoc](https://asciidoc.org/) (`*.adoc`)
6-
file into the `features` folder.
7-
You can find an AsciiDoc template `feature.adoctemplate` in the `features` folder.
8-
9-
AsciiDoc files can be organized into subfolders.
10-
11-
For more information about the AsciiDoc syntax, see the [AsciiDoc Syntax Quick Reference](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/).
5+
See [CONTRIBUTING.md](CONTRIBUTING.md)
126

137
## Building the website locally
148

0 commit comments

Comments
 (0)