Skip to content

Commit

Permalink
Make it clearer in CONTRIBUTING.md how devs can make pre-commit work (#…
Browse files Browse the repository at this point in the history
…985)

* Create .pre-commit-config.yaml

* Added extra clarification on how to make pre-commit work
  • Loading branch information
eurunuela authored Oct 23, 2023
1 parent 3450103 commit b11d254
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,27 @@ Here are some [instructions][link_signupinstructions].

Already know what you're looking for in this guide? Jump to the following sections:

* [Joining the conversation](#joining-the-conversation)
* [Contributing small documentation changes](#contributing-small-documentation-changes)
* [Contributing through Github](#contributing-through-github)
* [Understanding issues, milestones, and project boards](#understanding-issues-milestones-and-project-boards)
* [Installing in editable mode](#3-Run-the-developer-setup)
* [Making a change](#making-a-change)
* [Testing your change](#5-Test-your-changes)
* [Viewing Documentation Locally](#Changes-to-documentation)
* [Structuring contributions](#style-guide)
* [Recognizing contributors](#Recognizing-contributors)
* [Monthly calls and testing guidelines][link_developing_rtd]
- [Contributing to `tedana`](#contributing-to-tedana)
- [Joining the conversation](#joining-the-conversation)
- [Contributing small documentation changes](#contributing-small-documentation-changes)
- [Contributing through GitHub](#contributing-through-github)
- [Understanding issues, milestones and project boards](#understanding-issues-milestones-and-project-boards)
- [Issue labels](#issue-labels)
- [Making a change](#making-a-change)
- [1. Comment on an existing issue or open a new issue referencing your addition](#1-comment-on-an-existing-issue-or-open-a-new-issue-referencing-your-addition)
- [2. Fork the tedana repository to your GitHub profile](#2-fork-the-tedana-repository-to-your-github-profile)
- [3. Run the developer setup](#3-run-the-developer-setup)
- [4. Make the changes you've discussed](#4-make-the-changes-youve-discussed)
- [5. Test your changes](#5-test-your-changes)
- [Changes to documentation](#changes-to-documentation)
- [6. Submit a pull request](#6-submit-a-pull-request)
- [Pull Requests](#pull-requests)
- [Pull Request Checklist (For Fastest Review):](#pull-request-checklist-for-fastest-review)
- [Comprehensive Developer Guide](#comprehensive-developer-guide)
- [Style Guide](#style-guide)
- [Writing in ReStructuredText](#writing-in-restructuredtext)
- [Recognizing contributors](#recognizing-contributors)
- [Thank you!](#thank-you)

Don't know where to get started?
Read [Joining the conversation](#joining-the-conversation) and pop into
Expand Down Expand Up @@ -295,7 +305,13 @@ We use [black][link_black] and [isort][link_isort] to enforce this code style,
and we strongly recommend running both tools on your fork before opening a pull request.
We use [pre-commit][link_precommit] to automatically fix style issues when commit is
pushed rather than making contributors try to figure out why a contribution is out of compliance
with the style guides.
with the style guides. For pre-commit to work, make sure you install it following the guidelines
in the [pre-commit documentation][link_precommit], and then run
```
pre-commit install
```
from within your local `tedana` repository to install the pre-commit hooks that are used to
enforce style guidelines.

Additionally, we have adopted a primarily functional approach in `tedana`,
so we avoid defining our own classes within the library unless absolutely necessary.
Expand Down

0 comments on commit b11d254

Please sign in to comment.