Skip to content

Add contributing docs and scripts/docs - #104

Merged
yeraydiazdiaz merged 5 commits into
encode:masterfrom
yeraydiazdiaz:contributing-docs
Jun 6, 2020
Merged

Add contributing docs and scripts/docs#104
yeraydiazdiaz merged 5 commits into
encode:masterfrom
yeraydiazdiaz:contributing-docs

Conversation

@yeraydiazdiaz

@yeraydiazdiazyeraydiazdiaz commented May 31, 2020

Copy link
Copy Markdown
Contributor

Closes#95

Images are shared with HTTPX once encode/httpx#1011 is merged.

@yeraydiazdiaz
yeraydiazdiaz requested a review from a teamJune 2, 2020 09:55
florimondmanca
florimondmanca approved these changes Jun 6, 2020
View reviewed changes

@florimondmancaflorimondmanca left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Just a few nits and suggestions, but happy to get this in when you think it's ready enough.

Comment threaddocs/contributing.md
Comment threaddocs/contributing.md

We welcome contributors to:

- Try [HTTPX](https://www.python-httpx.org), as it is HTTP Core's main entry point,

@florimondmancaflorimondmancaMay 31, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe?

Suggested change
- Try [HTTPX](https://www.python-httpx.org), as it is HTTP Core's main entry point,
- Try [HTTPX](https://www.python-httpx.org), as it is HTTPCore's main dependent,

@yeraydiazdiazyeraydiazdiazJun 6, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those are slightly different, in my mind. "Entry point" underlines that you people should use HTTPX to interact with HTTP Core. Whereas "dependent" is a bit more broad?

Comment threaddocs/contributing.md Outdated
Comment threaddocs/contributing.md Outdated
Comment threaddocs/contributing.md Outdated
Comment threaddocs/contributing.md Outdated
Comment threaddocs/contributing.md
Yeray Diaz Diazand others added 4 commits June 6, 2020 09:45
Yeray Diaz Diaz@florimondmanca
Update docs/contributing.md
5ae7d8f
Co-authored-by: Florimond Manca <florimond.manca@gmail.com>
Yeray Diaz Diaz@florimondmanca
Update docs/contributing.md
dc5124d
Co-authored-by: Florimond Manca <florimond.manca@gmail.com>
Yeray Diaz Diaz
Fix missing httpcore
e204e20
Yeray Diaz Diaz
Tweak log level example and add link to HTTPX's docs
245ad48
@yeraydiazdiaz
yeraydiazdiaz merged commit 7415731 into encode:masterJun 6, 2020
@yeraydiazdiaz

yeraydiazdiaz commented Jun 6, 2020

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @florimondmanca 👍

@yeraydiazdiaz
yeraydiazdiaz deleted the contributing-docs branch June 6, 2020 14:45
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@florimondmancaflorimondmancaflorimondmanca approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add contributing documentation

2 participants

@yeraydiazdiaz@florimondmanca