Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Contribution docs page #1197

Closed
Kludex opened this issue Sep 23, 2021 · 4 comments · Fixed by #1224
Closed

[DOCS] Contribution docs page #1197

Kludex opened this issue Sep 23, 2021 · 4 comments · Fixed by #1224
Labels
docs Improve documentation

Comments

@Kludex
Copy link
Sponsor Member

Kludex commented Sep 23, 2021

Similar to https://www.python-httpx.org/contributing/ but addapted to uvicorn.

@Kludex Kludex added the docs Improve documentation label Sep 23, 2021
@LuluNwenyi
Copy link

Hi @Kludex I'd like to work on this but could you elaborate so I could get more context

@Kludex
Copy link
Sponsor Member Author

Kludex commented Oct 3, 2021

Hi @LuluNwenyi ! Thanks for the interest!

There are some things on the httpx page that doesn't make sense for us, like the Development proxy setup section.
And on the Releasing section, we don't have a __version__.py, but we change the version on the __init__.py.

Besides, on the Reporting Bugs or Other Issues section, on httpx is recommended to open a discussion, and there are some labels, but we don't have here, so I guess on uvicorn the idea would be to first discuss on our Gitter server, and if it makes sense, create an issue here.

The page should be called contributing.md, and it should be the last on the docs.

@LuluNwenyi
Copy link

Alright. I can be assigned to this.'d love to give it a go

@Kludex
Copy link
Sponsor Member Author

Kludex commented Oct 4, 2021

Go ahead!

humrochagf added a commit to humrochagf/uvicorn that referenced this issue Oct 20, 2021
Kludex pushed a commit that referenced this issue Nov 23, 2021
* Add contributing page to the docs (#1197)

* Applying suggestions to contributing page
Kludex pushed a commit to sephioh/uvicorn that referenced this issue Oct 29, 2022
* Add contributing page to the docs (encode#1197)

* Applying suggestions to contributing page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improve documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants