Skip to content

Commit fb1efcc

Browse files
author
Oleksandr Kulkov
committed
instructions with regard to mkdocs.yml
1 parent 0c13aa7 commit fb1efcc

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/contrib.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@ In order to make contribution consider the following steps:
1919
In case you want to make some bigger changes, like adding a new article, or edit multiple files, you should fork the project in the traditional way, create a branch, modify the files in the Github UI or locally on your computer, and create a pull-request.
2020
If you are unfamiliar with the workflow, read [Step-by-step guide to contributing on GitHub](https://www.dataschool.io/how-to-contribute-on-github/).
2121

22-
In case you are adding a new article, make sure to link to the article from the main ([index.md](https://github.com/e-maxx-eng/e-maxx-eng/blob/master/src/index.md)) page and in [README.md](https://github.com/e-maxx-eng/e-maxx-eng/blob/master/README.md) to announce it.
22+
If you're making a new article or moving existing one to a different place, please make sure that your changes are reflected in
23+
24+
- The list of all articles in [index.md](https://github.com/e-maxx-eng/e-maxx-eng/blob/master/src/index.md);
25+
- The list of all articles in [mkdocs.yml](https://github.com/e-maxx-eng/e-maxx-eng/blob/master/mkdocs.yml);
26+
- The list of new articles in [index.md](https://github.com/e-maxx-eng/e-maxx-eng/blob/master/src/index.md) and [README.md](https://github.com/e-maxx-eng/e-maxx-eng/blob/master/README.md) (if it is a new article).
2327

2428
## Syntax
2529

0 commit comments

Comments
 (0)