Skip to content

Commit 0a2688a

Browse files
authored
docs: remove commit hook stuff from contributing doc (#13608)
This change removes outdated information on commit hooks from the contributing document. It also adds a clear pointer to the local dev env setup documentation. ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [ ] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
1 parent a776505 commit 0a2688a

File tree

1 file changed

+2
-13
lines changed

1 file changed

+2
-13
lines changed

docs/contributing.rst

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ if you'd like to report a bug or request a new feature.
1212

1313
Before working on the library, install `docker <https://www.docker.com/products/docker>`_.
1414

15+
If you're trying to set up a local development environment, read `this <https://github.com/DataDog/dd-trace-py/tree/main/docs/contributing-testing.rst>`_.
16+
1517
Thanks for working with us!
1618

1719
.. _change_process:
@@ -34,8 +36,6 @@ Correctness and code style are automatically checked in continuous integration,
3436
various tools including Flake8, Black, and MyPy. This means that code reviews don't need to worry about style
3537
and can focus on substance.
3638

37-
If you get errors from ``git commit`` that mention "pre-commit", run ``$ rm .git/hooks/pre-commit`` and try again.
38-
3939
Branches and Pull Requests
4040
--------------------------
4141

@@ -69,17 +69,6 @@ Each minor version has its own branch.
6969
If your pull request is a ``fix`` or ``ci`` change, apply the backport labels corresponding to the minor
7070
versions that need the change.
7171

72-
Commit Hooks
73-
------------
74-
75-
The tracer library uses formatting/linting tools including black, flake8, and mypy.
76-
While these are run in each CI pipeline for pull requests, they are automated to run
77-
when you call `git commit` as pre-commit hooks to catch any formatting errors before
78-
you commit.
79-
80-
To initialize the pre-commit hook script to run in your development
81-
branch, run ``$ hooks/autohook.sh install``.
82-
8372
Implementation Guidelines
8473
=========================
8574

0 commit comments

Comments
 (0)