Skip to content

Commit 777da14

Browse files
committed
Add a short contributing guide
1 parent 0703324 commit 777da14

3 files changed

Lines changed: 42 additions & 2 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,5 +107,5 @@ The API returns rows in a different order on each run.
107107
workflow executes every fenced block in the README against the real API.
108108
- The field table and the "last verified" badge are rewritten by the daily run.
109109
Do not edit either by hand.
110-
- Keep it small: 14 files and about 300 lines of Python. Do not add retries,
110+
- Keep it small: 15 files and about 300 lines of Python. Do not add retries,
111111
deduplication, scheduling, databases, async examples or concurrency.

‎CONTRIBUTING.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
The most useful thing you can send us is a broken example.
4+
5+
## Report a bug
6+
7+
[Open an issue](https://github.com/brightdata/amazon-scraper-python/issues) and include:
8+
9+
- the command or the snippet you ran
10+
- what you expected, and what happened instead
11+
- your versions: `python --version` and `pip show brightdata-sdk`
12+
13+
Paste the error text rather than a screenshot of it. Never paste your API
14+
token, in an issue or anywhere else.
15+
16+
Questions about the API, your account or your credits go to
17+
[Bright Data support](https://brightdata.zendesk.com/hc/en-us/requests/new).
18+
We cannot see your account from here.
19+
20+
## Send a pull request
21+
22+
Small fixes need no permission. For anything larger, open an issue first, so
23+
that nobody writes the same code twice.
24+
25+
Before you push, check that:
26+
27+
- `pytest` passes offline, with no token set
28+
- `ruff check .` is clean
29+
- every fenced block in the README still runs exactly as pasted
30+
31+
## What this repo will not take
32+
33+
It stays small on purpose: 15 files and about 300 lines of Python. Read
34+
[AGENTS.md](AGENTS.md) first. It lists what is missing here deliberately,
35+
including retries, deduplication, scheduling, databases and concurrency.
36+
37+
The outputs in the README come from real runs, and a scheduled job reruns them
38+
against the live API. Do not edit those blocks, the field table or the
39+
"last verified" badge by hand.

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,8 @@ Data connects to, from LangChain to Zapier and n8n:
461461
## Support
462462

463463
Bugs in this repo:
464-
[open an issue](https://github.com/brightdata/amazon-scraper-python/issues).
464+
[open an issue](https://github.com/brightdata/amazon-scraper-python/issues), and
465+
[CONTRIBUTING.md](CONTRIBUTING.md) says what to put in it.
465466
Anything about the API, your account or your credits:
466467
[Bright Data support](https://brightdata.zendesk.com/hc/en-us/requests/new).
467468

0 commit comments

Comments
 (0)