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

Move the comment block from worker/index.js to CONTRIBUTING.md #12

Closed
SerpentBytes opened this issue Nov 16, 2022 · 1 comment
Closed
Assignees
Labels
🗒️ documentation Improvements or additions to documentation

Comments

@SerpentBytes
Copy link
Collaborator

SerpentBytes commented Nov 16, 2022

Description

This issue is related to the PR created for #1. We want to extract the auto-generated comment block at the top of the worker/index.js and add it to CONTRIBUTING.md.

The comment block looks as follows:

 *
  * - Run `npx wrangler dev src/index.js` in your terminal to start a development server
  * - Open a browser tab at http://localhost:8080/ to see your worker in action
  * - Run `npx wrangler publish src/index.js --name my-worker` to publish your worker
  *
  * Learn more at https://developers.cloudflare.com/workers/
  */

Additional Information

Note: The file has undergone some changes since it was first generated, so some of the information in the comment block, such as the file path and port number, may be outdated.

@SerpentBytes SerpentBytes added the 🗒️ documentation Improvements or additions to documentation label Nov 16, 2022
@rudychung
Copy link
Contributor

Could I give this a try? I'm not 100% sure what is wanted though, just moving the block comment content over to CONTRIBUTING.md?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🗒️ documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants