From c8b3e07d5fb438844ff215d0dd906360fc95cae5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Boris=20Cl=C3=A9net?= Date: Fri, 21 Jul 2023 10:36:41 +0200 Subject: [PATCH] [DOC] Precisions on pull requests --- .github/ISSUE_TEMPLATE/pipeline_reproduction.yml | 4 ++-- CONTRIBUTING.md | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/pipeline_reproduction.yml b/.github/ISSUE_TEMPLATE/pipeline_reproduction.yml index 11929922..dd0f0a7d 100644 --- a/.github/ISSUE_TEMPLATE/pipeline_reproduction.yml +++ b/.github/ISSUE_TEMPLATE/pipeline_reproduction.yml @@ -50,12 +50,12 @@ body: Please tick the boxes below once the corresponding task is finished. :+1: - [ ] :ok_hand: A maintainer of the project approved the issue, by assigning a :checkered_flag:`status: ready for dev` label to it. - [ ] :deciduous_tree: Create a branch on your fork to start the reproduction. - - [ ] :sunrise: Create a file `team_{team_id}.py` inside the [`narps_open/pipelines/`](https://github.com/Inria-Empenn/narps_open_pipelines/blob/main/narps_open/pipelines) directory. You can use a file inside [`narps_open/pipelines/templates`](https://github.com/Inria-Empenn/narps_open_pipelines/blob/main/narps_open/pipelines/templates) file as a template if needed. + - [ ] :sunrise: Create a file `team_{team_id}.py` inside the [`narps_open/pipelines/`](https://github.com/Inria-Empenn/narps_open_pipelines/blob/main/narps_open/pipelines) directory. You can use a file inside [`narps_open/pipelines/templates`](https://github.com/Inria-Empenn/narps_open_pipelines/blob/main/narps_open/pipelines/templates) as a template if needed. + - [ ] :inbox_tray: Create a [pull request](https://github.com/Inria-Empenn/narps_open_pipelines/blob/main/CONTRIBUTING.md#pull_requests) as soon as you completed the previous task. - [ ] :brain: Write the code for the pipeline, using Nipype and the file architecture described in [docs/pipelines.md](https://github.com/Inria-Empenn/narps_open_pipelines/blob/main/docs/pipelines.md). - [ ] :blue_book: Make sure your code is documented enough. - [ ] :snake: Make sure your code is explicit and conforms with PEP8. - [ ] :microscope: Create tests for your pipeline. You can use files in [`tests/pipelines/test_team_*`](https://github.com/Inria-Empenn/narps_open_pipelines/blob/main/tests/pipelines/) as examples. - [ ] :microscope: Make sure your code passes all the tests you created (see [docs/testing.md](https://github.com/Inria-Empenn/narps_open_pipelines/blob/main/docs/testing.md)). - - [ ] :inbox_tray: create a [pull request](https://github.com/Inria-Empenn/narps_open_pipelines/blob/main/CONTRIBUTING.md#pull_requests) from your code. validations: required: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 469e5e64..e859d510 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,9 +52,11 @@ Create a separate branch for each issue you're working on. Do not make changes t Push your code as soon as possible. ### Create the Pull Request (PR) :inbox_tray: -Once you pushed your first lines of code to the branch in your fork, visit [this page](https://github.com/Inria-Empenn/narps_open_pipelines/pulls) to start creating a PR for the NARPS Open Pipelines project. :warning: Please create a **Draft Pull Request** as described [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) in the GitHub documentation. +Once you pushed your first lines of code to the branch in your fork, visit [this page](https://github.com/Inria-Empenn/narps_open_pipelines/pulls) to start creating a PR for the NARPS Open Pipelines project. -Continue writing your code and push to the same branch. Make sure to respect all the items of the PR checklist. +:warning: Please create a **Draft Pull Request** as described [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork), and please stick to the PR description template as much as possible. + +Continue writing your code and push to the same branch. Make sure you perform all the items of the PR checklist. ### Request Review :disguised_face: Once your PR is ready, you may add a reviewer to your PR, as described [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) in the GitHub documentation.