Skip to content

Commit

Permalink
[DOC] about contributing to the project
Browse files Browse the repository at this point in the history
  • Loading branch information
bclenet committed Jun 23, 2023
1 parent d206240 commit 64b5edd
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 26 deletions.
50 changes: 26 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,55 @@
# HOW TO CONTRIBUTE TO OPEN PIPELINE ?
# How to contribute to NARPS Open Pipelines ?

General guidelines can be found [here](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) in the GitHub documentation.

## Reproduce a pipeline ⌨️
## Reproduce a pipeline :keyboard:
:thinking: Not sure which one to start with ? You can have a look on [this table](/docs/pipeline_status.md) giving the work progress status for each pipeline. This will help choosing the one that best suits you!

:thinking: Not sure which one to start with ? You can have a look on [this table](/docs/pipeline_status.md) giving the status of the work on each pipeline. This will help choosing the one that best suits you !
[Start an issue](https://github.com/Inria-Empenn/narps_open_pipelines/issues/new/choose) and choose **Pipeline reproduction**.

### If you have experience with NiPype

We created a template with modifications to make and holes to fill to create a pipeline. You can find it on [`narps_open/pipelines/pipeline_template.py`](/narps_open/pipelines/pipeline_template.py).
If you feel it could be better explained, do not hesitate to modify the template or to create an issue about it.

### If you have experience with the original software package but not with NiPype

A fantastic tool named [Giraffe](https://giraffe.tools/porcupine/TimVanMourik/GiraffePlayground/master) is available. It allows you to create a graph of your pipeline using NiPype functions but without coding! Just save your NiPype script in a .py file and send it as a new issue, we will convert this script to a script which works with our specific parameters.

## Find or propose an issue 📋

## Find or propose an issue :clipboard:
Issues are very important for this project. If you want to contribute, you can either **comment an existing issue** or **proposing a new issue**.

### Answering an existing issue 🏷
### Answering an existing issue :label:
To answer an existing issue, make a new comment with the following information:
- Your name and/or github username
- The step you want to contribute to
- The approximate time needed

### Proposing a new issue 💡
- When opening a **Feature request**, you aim at improving the project with your ideas
- If you encounter a problem or if there is a bug, please open a **Bug report** issue
- Whenever you want, you can open a **Classic issue** to ask question, give feedbacks...
### Proposing a new issue :bulb:
In order to start a new issue, click [here](https://github.com/Inria-Empenn/narps_open_pipelines/issues/new/choose) and choose the type of issue you want:
- **Feature request** if you aim at improving the project with your ideas ;
- **Bug report** if you encounter a problem or identified a bug ;
- **Classic issue** to ask question, give feedbacks...

Some issues are (probably) already open, **don't hesitate to take a look at them.** Maybe your issue was already reported and in that case you may want to add details or other circumstances in which a problem appear.

## Pull Requests 📥
Some issues are (probably) already open, please browse them before starting a new one. If your issue was already reported, you may want complete it with details or other circumstances in which a problem appear.

## Pull Requests :inbox_tray:
Pull requests are the best way to get your ideas into this repository and to solve the problems as fast as possible.

### Make A Branch 🌳
### Make A Branch :deciduous_tree:
Create a separate branch for each issue you're working on. Do not make changes to the default branch (e.g. master, develop) of your fork.

### Push Your Code 📤
Push your code as soon as you can and make a pull request with a "[WIP]" in the title.
### Push Your Code :outbox_tray:
Push your code as soon and often as you can.

### Create the Pull Request (PR) :inbox_tray:
To learn how to create a PR, visit the GitHub documentation [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).

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 in the previous link.

### Fulfill the Pull Request template 📝
Use the format specified in pull request template for the repository.
Make sure to respect all the items of the PR checklist.

### Request Review 🥸
Once your Pull Request is ready, you can remove the "[WIP]" from the title.
### 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.

**Important**: Be careful to respect all items of the Pull Request checklist (available in [Pull Request template](https://github.com/elodiegermani/open_pipeline/blob/main/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md))
Please turn your Draft Pull Request into a "regular" Pull Request, by clicking **Ready for review** in the Pull Request page.

**Thank you in advance for contributing to the project!**
**:wave: Thank you in advance for contributing to the project!**
2 changes: 1 addition & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# HOW TO INSTALL NARPS OPEN PIPELINES ?
# How to install NARPS Open Pipelines ?

## 1 - Get the code

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# THE OPEN PIPELINE PROJECT
# The NARPS Open Pipelines project

<p align="center">
<img src="assets/images/project_illustration.png"/>
Expand Down

0 comments on commit 64b5edd

Please sign in to comment.