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.

Sign up for GitHub

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

Jump to bottom

Document methods in the repo #64

Closed
adam4leos opened this issue Sep 20, 2023 · 6 comments · Fixed by #82
Closed

Document methods in the repo #64

adam4leos opened this issue Sep 20, 2023 · 6 comments · Fixed by #82
Assignees
@KhoiUna
Labels
good first issue Good for newcomers hacktoberfest For the hacking month of October help wanted Extra attention is needed

Comments

@adam4leos
Copy link
Contributor

adam4leos commented Sep 20, 2023 •
edited by EbonyLouis
Loading

Background:

We're (unfortunately) lacking method docs, and having some would be amazing.

Task Details:

Consider covering methods in the repo, especially public and less straightforward, with some jsdocs style comment

example

/**
   * Handler for opening websocket event - `connection`.
   * Sets listeners for `message`, `pong`, `close`, and `error` events.
   */
#handleConnection(socket: WebSocket, _request: IncomingMessage): void {
  const dwn = this.dwn;
  // ...rest of the code...

Picking Up This Issue:

  • If you'd like to work on this, please comment "picking this up" below, and I'll assign the issue to you

Questions:

Resources:

  • Creating a Pull Request: If you're new to GitHub and unsure how to create a pull request, follow this step-by-step guide.

Remember, communication is key! If you have any questions or face any challenges, we're here to help so please don't hesitate to reach out.

Good Luck! 🍁
@adam4leos adam4leos added good first issue Good for newcomers help wanted Extra attention is needed hacktoberfest For the hacking month of October labels Sep 20, 2023
@MaticSulc
Copy link

Picking this up! :)

@EbonyLouis
Copy link
Contributor

@MaticSulc yay! I've assigned it to you!

I'd also like to note that Hacktoberfest officially kicks off on October 1st. Contributions made before the event may not be eligible for the challenge. However, feel free to start working on it, but I'd recommend holding off on submitting your PR until the event begins.

to be eligible for Hacktoberfest's official prizes make sure you're registered, registration is now OPEN.

@EbonyLouis
Copy link
Contributor

Hey @MaticSulc would you still like to work on this issue?

@KhoiUna
Copy link
Contributor

KhoiUna commented Oct 25, 2023 •
edited
Loading

Hey @MaticSulc would you still like to work on this issue?

Can I pick this one up if it's not being worked on? @EbonyLouis

@EbonyLouis
Copy link
Contributor

Hey @KhoiUna yes you can work on it, thanks!

@EbonyLouis EbonyLouis assigned KhoiUna and unassigned MaticSulc Oct 26, 2023
@KhoiUna KhoiUna mentioned this issue Oct 29, 2023
Merged
@KhoiUna
Copy link
Contributor

KhoiUna commented Oct 29, 2023

@EbonyLouis Submitted a PR

finn-block pushed a commit that referenced this issue Oct 31, 2023
@KhoiUna
Issue #64 - Document methods in the repo (#82)
64bff7c 
* remove comment since issue #49 already fixed

* add method doc for `#setupServer`

* add method doc for `#setupRoutes`

* add method doc  for setupHeartbeat and setupWebSocket

* update doc for `#setupRoutes` in src/http-api.ts

* update doc for `#setupServer` in `src/dwn-server.ts`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@KhoiUna KhoiUna

Labels
good first issue Good for newcomers hacktoberfest For the hacking month of October help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Issue #64 - Document methods in the repo KhoiUna/dwn-server
4 participants
@adam4leos @MaticSulc @EbonyLouis @KhoiUna