OscervaME
/
stable-baselines3-contrib-sacd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Spell-checking and small update to issue template

This commit is contained in:
Anssi "Miffyli" Kanervisto 2020-10-15 02:50:16 +03:00
parent 4a1695cf7b
commit 00f9d26d55
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/ISSUE_TEMPLATE/issue-template.md vendored
View File

@ -32,6 +32,7 @@ for both code and stack traces.
```python ```python
from stable_baselines3 import ... from stable_baselines3 import ...
from sb3_contrib import ...
``` ```

6
CONTRIBUTING.md
View File

@ -19,8 +19,8 @@ Contributions and review focuses on following three parts:
in the documentation, in-code documentation to clarify the flow in the documentation, in-code documentation to clarify the flow
of logic and report of the expected results, where applicable. of logic and report of the expected results, where applicable.
3) Consistency with stable-baselines3 3) Consistency with stable-baselines3
- To ease readibility, all contributions need to follow the code style (see below) and - To ease readability, all contributions need to follow the code style (see below) and
ideoms used in stable-baselines3. idioms used in stable-baselines3.
The implementation quality is a strict requirements with little room for changes, because The implementation quality is a strict requirements with little room for changes, because
otherwise the implementation can do more harm than good (wrong results). Parts two and three otherwise the implementation can do more harm than good (wrong results). Parts two and three
@ -79,7 +79,7 @@ Below is a template for documentation for full training algorithms.
[Feature/Algorithm name] [Feature/Algorithm name]
======================== ========================
- Non-abreviated name and/or one-sentence description of the method. - Non-abbreviated name and/or one-sentence description of the method.
- Link and reference to the original publications the present the feature, or other established source(s). - Link and reference to the original publications the present the feature, or other established source(s).
- Links to any codebases that were used for reference (e.g. authors' implementations) - Links to any codebases that were used for reference (e.g. authors' implementations)