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

Create a CONTRIBUTING.md and document where APIs are #27

Open
Pi-Cla opened this issue May 22, 2024 · 2 comments
Open

Create a CONTRIBUTING.md and document where APIs are #27

Pi-Cla opened this issue May 22, 2024 · 2 comments

Comments

@Pi-Cla
Copy link
Contributor

Pi-Cla commented May 22, 2024

Hex has basically no documentation for their API, one has to dive into the code itself to figure out what to do across at least three different locations:

  1. https://github.com/hexpm/hexpm/tree/main/lib/hexpm_web/controllers this is a place where status codes are sent
  2. https://github.com/hexpm/hex/tree/main/lib/hex/api shows which URL paths and request types need to be sent
  3. https://github.com/hexpm/hex/tree/main/lib/mix/tasks shows what these APIs actually do

This ticket is mostly a reminder to myself to draft a CONTRIBUTING.md as a nice simple guide to add more functions and also add comments to every single request/response pair showing where the APIs currently are for future maintenance.

Maybe if I ever feel like I have nothing better to do I will even try to document all of the things upstream, like some sorta mdbook or something which shows where all the paths are and possible status codes are... but thats for the future

@Pi-Cla
Copy link
Contributor Author

Pi-Cla commented May 22, 2024

See also my comment here: hexpm/specifications#31 (comment)

@lpil
Copy link
Member

lpil commented May 22, 2024

Good idea! Thank you

Pi-Cla added a commit to Pi-Cla/hexpm-rust that referenced this issue May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants