From 7d5d7089f8822ea668d415c75bf6d98a21f7cf33 Mon Sep 17 00:00:00 2001 From: Elizabeth DuPre Date: Fri, 2 Nov 2018 17:15:26 -0400 Subject: [PATCH] Address Yarik's review comments --- CONTRIBUTING.md | 6 ++++-- docs/contributing.rst | 2 +- docs/roadmap.rst | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4dc34c87..d16b856ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ We also maintain a [gitter chat room][link_gitter] for more informal conversatio There is significant cross-talk between these two spaces, and we look forward to hearing from you in either venue! As a reminder, we expect all contributions to `tedana` to adhere to our [code of conduct][link_coc]. -## Explaining issues, milestones and project boards +## Understanding issues, milestones and project boards Every project on GitHub uses [issues][link_issues], [milestones][link_milestones], and [project boards][link_project_boards] slightly differently. @@ -110,7 +110,9 @@ When opening a pull request, please use at least one of the following prefixes: * **[TST]** for new or updated tests * **[DOC]** for new or updated documentation * **[STY]** for stylistic changes -* **[RF]** for refactoring existing code +* **[REF]** for refactoring existing code +* **[BRK]** for changes which break existing builds or tests +* **[WIP]** for changes which are not yet ready to be merged Pull requests should be submitted early and often! If your pull request is not yet ready to be merged, please also include the **[WIP]** prefix. diff --git a/docs/contributing.rst b/docs/contributing.rst index 748b4921f..629d4c10b 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -32,7 +32,7 @@ during any interaction with the project. That includes---but is not limited to---online conversations, in-person workshops or development sprints, and when giving talks about the software. -As is stated in the code, severe or repeated violations by community members may result in exclusion +As it is stated in the code, severe or repeated violations by community members may result in exclusion from collective decision-making and rejection of future contributions to the ``tedana`` project. .. _code of conduct: https://github.com/ME-ICA/tedana/blob/master/Code_of_Conduct.md diff --git a/docs/roadmap.rst b/docs/roadmap.rst index 5b503159e..2c8136157 100644 --- a/docs/roadmap.rst +++ b/docs/roadmap.rst @@ -98,7 +98,7 @@ the existing implementation. Moving forward, we want to grow an active development community, where developers feel empowered to explore new enhancements to the ``tedana`` code base. -One means to ensure that new code does not introduce silent failures is through extensive testing. +One means to ensure that new code does not introduce bugs is through extensive testing. We are therefore committed to implementing high test coverage at both the unit test and integration test levels; that is, both in testing individual functions and broader workflows, respectively.