Skip to content

Commit 02f94a2

Browse files
committed
move contributing to standalone document
1 parent 3a39878 commit 02f94a2

2 files changed

Lines changed: 29 additions & 27 deletions

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Contributing
2+
3+
Contributions are always welcome! Use the [Scraping Configuration](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md) help section to get started and stop by the [Discord](https://discord.gg/2TsNFKt) #scrapers channel with any questions.
4+
5+
### Language
6+
If possible, XPath or JSON based yml scrapers are always preferred over python scrapers unless explicitly required
7+
8+
### Validation
9+
10+
The scrapers in this repository can be validated against a schema and checked for common errors.
11+
12+
[Deno](https://deno.com/) is used as a drop-in, sandboxed NodeJS alternative
13+
14+
```sh
15+
# check all scrapers
16+
deno run -R=scrapers -R="validator\scraper.schema.json" validate.js
17+
# check specific scraper
18+
deno run -R=scrapers -R="validator\scraper.schema.json" validate.js scrapers/foo.yml scrapers/bar.yml
19+
```
20+
Deno asks for env and sys permissions from [chalk](https://www.npmjs.com/package/chalk)
21+
22+
#### Docker option
23+
24+
Instead of Deno, [Docker](https://docs.docker.com/engine/install/) can be used to run the validator
25+
26+
```sh
27+
docker run --rm -v .:/app denoland/deno:distroless run -R=/app/ -E /app/validate.js --ci
28+
```

README.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -96,30 +96,4 @@ Repository: https://github.com/stashapp/scrapers-repo-template
9696

9797
- **Forum:** [discourse.stashapp.cc](https://discourse.stashapp.cc) - Primary place for community support, feature requests, and discussions.
9898
- **Discord:** [discord.gg/2TsNFKt](https://discord.gg/2TsNFKt) - Real-time chat and community support.
99-
- **Lemmy:** [discuss.online/c/stashapp](https://discuss.online/c/stashapp) - Community discussions.
100-
101-
## Contributing
102-
103-
Contributions are always welcome! Use the [Scraping Configuration](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md) help section to get started and stop by the [Discord](https://discord.gg/2TsNFKt) #scrapers channel with any questions.
104-
105-
### Validation
106-
107-
The scrapers in this repository can be validated against a schema and checked for common errors.
108-
109-
[Deno](https://deno.com/) is used as a drop-in, sandboxed NodeJS alternative
110-
111-
```sh
112-
# check all scrapers
113-
deno run -R=scrapers -R="validator\scraper.schema.json" validate.js
114-
# check specific scraper
115-
deno run -R=scrapers -R="validator\scraper.schema.json" validate.js scrapers/foo.yml scrapers/bar.yml
116-
```
117-
Deno asks for env and sys permissions from [chalk](https://www.npmjs.com/package/chalk)
118-
119-
#### Docker option
120-
121-
Instead of Deno, [Docker](https://docs.docker.com/engine/install/) can be used to run the validator
122-
123-
```sh
124-
docker run --rm -v .:/app denoland/deno:distroless run -R=/app/ -E /app/validate.js --ci
125-
```
99+
- **Lemmy:** [discuss.online/c/stashapp](https://discuss.online/c/stashapp) - Community discussions.

0 commit comments

Comments
 (0)