diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md index 1268278..b8189aa 100644 --- a/.github/ISSUE_TEMPLATE/issue-template.md +++ b/.github/ISSUE_TEMPLATE/issue-template.md @@ -32,6 +32,7 @@ for both code and stack traces. ```python from stable_baselines3 import ... +from sb3_contrib import ... ``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4a54ac..decf076 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,8 +19,8 @@ Contributions and review focuses on following three parts: in the documentation, in-code documentation to clarify the flow of logic and report of the expected results, where applicable. 3) Consistency with stable-baselines3 - - To ease readibility, all contributions need to follow the code style (see below) and - ideoms used in stable-baselines3. + - To ease readability, all contributions need to follow the code style (see below) and + idioms used in stable-baselines3. 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 @@ -79,7 +79,7 @@ Below is a template for documentation for full training algorithms. [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). - Links to any codebases that were used for reference (e.g. authors' implementations)