Skip to content

Commit eb45217

Browse files
SadashiiRayBB
andauthored
Fixes to contributing.md (#12184)
Co-authored-by: Raymond Berger <RayBB@users.noreply.github.com>
1 parent 88000ee commit eb45217

1 file changed

Lines changed: 3 additions & 29 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ This welcome section is intended for new contributors.
2626
* [Request a slack invite](https://openlibrary.org/volunteer)
2727
* [Weekly Community calls](https://docs.openlibrary.org/everyone/community-call.html)
2828
* [Open Library FAQs](https://openlibrary.org/help/faq)
29+
2930
## Quick Tour
3031

3132
A quick public tour of Open Library to get you familiar with the service and its offerings (10min)
@@ -78,7 +79,7 @@ Refer to the [docs](https://docs.openlibrary.org/) for more information about ge
7879

7980
## Picking Good First Issues
8081

81-
[Here's a list of good first issues](https://github.com/internetarchive/openlibrary/issues?q=is%3Aissue+is%3Aopen+-linked%3Apr+label%3A%22Good+First+Issue%22+no%3Aassignee) to help you get started. Please only pick issues that are not assigned to anyone, or if an issue has been assigned but has seen no response or activity for 2 weeks. Do not request to be assigned to issues that are actively being worked on. If you're interested in working on an issue without an assignee or one that has been inactive, comment on it to ask if you can be assigned. If you have questions, please ask the [Lead](https://docs.openlibrary.org/developers/misc/project-management.html#triage) designated by the `Lead: @person` label on the issue.
82+
[Here's a list of good first issues](https://github.com/internetarchive/openlibrary/issues?q=is%3Aissue+is%3Aopen+-linked%3Apr+label%3A%22Good+First+Issue%22+no%3Aassignee) to help you get started. Please only pick issues that are not assigned to anyone, or if an issue has been assigned but has seen no response or activity for 2 weeks. Do not request to be assigned to issues that are actively being worked on. If you're interested in working on an issue without an assignee or one that has been inactive, comment on it to ask if you can be assigned. If you have questions, please ask the [Lead](https://docs.openlibrary.org/developers/misc/project-management.html#triage) designated by the `Lead: @person` label on the issue.
8283

8384
## Contributor Etiquette
8485

@@ -113,34 +114,7 @@ A branch name consists of the: issue number, whether it is a feature/hotfix/refa
113114
```
114115

115116
### Testing
116-
See https://docs.openlibrary.org/2_Developers/misc/Testing.html for more information.
117-
118-
## pre-commit hooks
119-
120-
Be confident in changing files you can check the quality (linter) with [pre-commit](https://pre-commit.com/index.html).
121-
It is used to inspect the snapshot that is about to be committed, to see if there are any syntax errors, typos, or a handful of other common issues.
122-
You can see the actions descriptions in [pre-commit-config.yml](https://github.com/internetarchive/openlibrary/blob/master/.pre-commit-config.yaml).
123-
124-
The pre-commit is automatically run against open PRs. Install the pre-commit locally to avoid waiting for the PR checks to run in the cloud.
125-
126-
### Installation
127-
128-
```
129-
pip install pre-commit
130-
# or on mac you can run
131-
brew install pre-commit
132-
```
133-
134-
After executing the last command, when you normally run `git commit`, pre-commit will also perform its checks.
135-
136-
### Running manually
137-
138-
```
139-
pre-commit run --files pre-commit-config.yml
140-
```
141-
142-
> **_Warning:_** If you don't clone with **ssh** then infogami will have pre-commit issues [You can read this section to resolve it](docker/README.md#cloning-the-open-library-repository).
143-
117+
See https://docs.openlibrary.org/developers/tools/testing.html for more information.
144118

145119
### Submitting Pull Requests
146120

0 commit comments

Comments
 (0)