Add listing of code owners/reviewers and reference from contribution guidelines

X-DeepSpeech: NOBUILD
This commit is contained in:
Reuben Morais 2020-12-04 15:16:15 +02:00
Родитель bcfc74874f
Коммит 73240a0f1d
2 изменённых файлов: 114 добавлений и 0 удалений

108
CODE_OWNERS.rst Normal file
Просмотреть файл

@ -0,0 +1,108 @@
DeepSpeech code owners
======================
This file describes reviewers who are active on the project and which parts of the code they have expertise on (and interest in). If you're making changes to the code and are wondering who's an appropriate person to talk to, this list will tell you who to ping.
There's overlap in the areas of expertise of each reviewer, and in particular when looking at which files are covered by each area, there is a lot of overlap. Don't worry about getting it exactly right when requesting review, any code owner will be happy to redirect the request to a more appropriate question.
Global reviewers
----------------
These are people who have worked on the project extensively and are familiar with all or most parts of it. Their expertise and review guidance is trusted by other code owners to cover their own areas of expertise. In case of conflicting opinions from other reviewers, global reviewers will make a final decision.
- Alexandre Lissy (@lissyx)
- Reuben Morais (@reuben)
Training, feeding
-----------------
- Reuben Morais (@reuben)
Model exporting
---------------
- Alexandre Lissy (@lissyx)
Transfer learning
-----------------
- Josh Meyer (@JRMeyer)
- Reuben Morais (@reuben)
Testing & CI
------------
- Alexandre Lissy (@lissyx)
- Reuben Morais (@reuben)
Native inference client
-----------------------
Everything that goes into libdeepspeech.so and is not specifically covered in another area fits here.
- Alexandre Lissy (@lissyx)
- Reuben Morais (@reuben)
Streaming decoder
-----------------
- Reuben Morais (@reuben)
- @dabinat
Python bindings
---------------
- Alexandre Lissy (@lissyx)
- Reuben Morais (@reuben)
Java Bindings
-------------
- Alexandre Lissy (@lissyx)
JavaScript/NodeJS/ElectronJS bindings
-------------------------------------
- Alexandre Lissy (@lissyx)
- Reuben Morais (@reuben)
.NET bindings
-------------
- Carlos Fonseca (@carlfm01)
Swift bindings
--------------
- Reuben Morais (@reuben)
Android support
---------------
- Alexandre Lissy (@lissyx)
Raspberry Pi support
--------------------
- Alexandre Lissy (@lissyx)
Windows support
---------------
- Carlos Fonseca (@carlfm01)
iOS support
-----------
- Reuben Morais (@reuben)
Documentation
-------------
- Alexandre Lissy (@lissyx)
- Reuben Morais (@reuben)
Third party bindings
--------------------
Hosted externally and owned by the individual authors. See the `list of third-party bindings <https://deepspeech.readthedocs.io/en/master/USING.html#third-party-bindings>`_ for more info.

Просмотреть файл

@ -33,6 +33,12 @@ Whenever you add a new feature to DeepSpeech and what to contribute that feature
2. You've made changes to the Python code. Make sure you run a linter (described below).
3. Make sure your new feature doesn't regress the project. If you've added a significant feature or amount of code, you want to be sure your new feature doesn't create performance issues. For example, if you've made a change to the DeepSpeech decoder, you should know that inference performance doesn't drop in terms of latency, accuracy, or memory usage. Unless you're proposing a new decoding algorithm, you probably don't have to worry about affecting accuracy. However, it's very possible you've affected latency or memory usage. You should run local performance tests to make sure no bugs have crept in. There are lots of tools to check latency and memory usage, and you should use what is most comfortable for you and gets the job done. If you're on Linux, you might find [[perf](https://perf.wiki.kernel.org/index.php/Main_Page)] to be a useful tool. You can use sample WAV files for testing which are provided in the `DeepSpeech/data/` directory.
Requesting review on your PR
----------------------------
Generally, a code owner will be notified of your pull request and will either review it or ask some other code owner for their review. If you'd like to proactively request review as you open the PR, see the the CODE_OWNERS.rst file which describes who's an appropriate reviewer depending on which parts of the code you're changing.
Python Linter
-------------