From 71f5746711c1f4fa923f7dd2070d86f9e09a9dcf Mon Sep 17 00:00:00 2001 From: Valdis Vitolins Date: Mon, 2 Sep 2019 23:06:52 +0300 Subject: [PATCH] docs: add some more explanations, do some reorganization of steps --- docs/contributing.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index a51a0f0b..c5fe5d5a 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -10,12 +10,16 @@ old version. Before registering new issue, test that issue can be reproduced wit [eSpeak NG online](https://odo.lv/Espeak) site. 2. Review known [eSpeak NG issues](https://github.com/espeak-ng/espeak-ng/issues), particularly about -[languages](https://github.com/espeak-ng/espeak-ng/labels/languages%2Fpronunciation) and add your comments -on existing issues. If necessary add new issue as described [here](https://help.github.com/en/articles/creating-an-issue). +[languages](https://github.com/espeak-ng/espeak-ng/labels/languages%2Fpronunciation) and add your comments on existing issues. 3. Look at and subscribe to [eSpeakNG mailing list](https://groups.io/g/espeak-ng) to view and discuss other related topics. +4. If you decide to create new issue, look at guide [here](https://help.github.com/en/articles/creating-an-issue) and provide following information: + +1. example of text, which demonstrates and allows to reproduce spelling error; +2. explanation, why produced spelling is wrong and how it should be corrected. + ## Steps for your contribution 1. Get familiar with [additive speech synthesis](https://en.wikipedia.org/wiki/Speech_synthesis#Formant_synthesis). @@ -29,13 +33,13 @@ to view and discuss other related topics. 6. Make your improvements (i.e. additions or modifications) and check your project with `make check` command. Fix issues if necessary. -7. If you contribute to an existing language, find language maintainer in language configuration file located in `espeak-ng-data/lang` folder[1](#1) and ask him to review your changes. If you can't find language maintainer, you can review list of all contributors[2](#2) and contact them. You can also volunteer to become language maintainer just by updating language configuration file. +7. If you contribute to an existing language, find language maintainer in language configuration file located in `espeak-ng-data/lang` folder[1](#1) and ask him to review your changes. If you can't find language maintainer, you can review list of all contributors[2](#2) and contact them. You can also volunteer to become language maintainer just by updating [language configuration file](voices.md) and submitting your changes as it is described in [step 9](#9). -8. [Push your changes to GitHub](https://help.github.com/en/articles/pushing-commits-to-a-remote-repository) and create [pull request](https://help.github.com/en/articles/creating-a-pull-request). You can also send changed files by email to [eSpeakNG mailing list](https://groups.io/g/espeak-ng) (but then inlusion of them may take more time). +8. If you contribute to the core of espeak-ng engine (i.e. source files of software), you may just issue pull requests as described in [step 9](#9). Note that `make check` must pass and there should not be merging conflicts (and for new/extended functionality new tests should be created). If you are ready to take responsibility, ask [current maintainers](https://github.com/espeak-ng/espeak-ng/people) to get promoted as a maintainer of the project. -9. Wait for feedback of current espeak-ng maintainers[3](#3). +9. [Push your changes to GitHub](https://help.github.com/en/articles/pushing-commits-to-a-remote-repository) and create [pull request](https://help.github.com/en/articles/creating-a-pull-request). You can also send changed files by email to [eSpeakNG mailing list](https://groups.io/g/espeak-ng), but then inlusion of them may take more time. -10. If you feel ready to take responsibility, ask existing maintainers to become promoted as a maintainer of the project. +10. Wait for feedback of current espeak-ng maintainers[3](#3). ----