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

Need to write READMEs for all samples #798

Open
2 tasks
jpmedley opened this issue Jan 5, 2023 · 30 comments
Open
2 tasks

Need to write READMEs for all samples #798

jpmedley opened this issue Jan 5, 2023 · 30 comments
Labels
enhancement P0

Comments

@jpmedley
Copy link
Contributor

jpmedley commented Jan 5, 2023 •
edited

One paragraph each:

  • A high-level description.
  • Context that helps with understanding the sample.

Exclude MV2 samples.
@shreya024
Copy link
Contributor

@jpmedley I would like to work on this issue.Kindly assign

@jpmedley
Copy link
Contributor Author

jpmedley commented Mar 23, 2023 •
edited

Thank you! This kind of thing requires a consistent format. We have instructions drafted, but haven't published them yet. I will get back to you in a day or two.

cc @oliverdunk

@shreya024
Copy link
Contributor

Thank you! This kind of thing requires a consistent format. We have instructions drafted, but haven't published them yet. I will get back to you in a day or two.

cc @oliverdunk

Okay thank you

@jpmedley
Copy link
Contributor Author

Gang,

Thank you for your offer of help. We finally have instructions for how to do a README.

The reason I asked you to wait is that for an application like this, we want the instructions to be fairly consistent from one README to the next. Please follow these instructions.

If you run into anything that doesn't fit, ask yourself if it could apply to more than just the README you're working on and contact me (jmedley@google.com) with your proposed solution.

Thanks,
Joe

@tusharv01
Copy link

please assigned me this issue

@jpmedley
Copy link
Contributor Author

jpmedley commented Apr 4, 2023

Thank you for your offer of help. Since we have several other people working on this, it doesn't need to be assigned for you to work on it. Please just pick a few that you want to write for and announce in this thread that you're working on them so that we don't duplicate effort.

Thanks.

@shreya024
Copy link
Contributor

Thank you for your offer of help. Since we have several other people working on this, it doesn't need to be assigned for you to work on it. Please just pick a few that you want to write for and announce in this thread that you're working on them so that we don't duplicate effort.

Thanks.

@jpmedley I'm working on the api-samples

@jpmedley
Copy link
Contributor Author

jpmedley commented Apr 4, 2023

Is anyone else on this thread working in that folder? We may need to coordinate.

@ankitoid
Copy link

@jpmedley I am new GSOC contributor and i would like to work on this issue. Kindly assign

@oliverdunk
Copy link
Member

Just to re-iterate what @jpmedley said, we don't want to assign an issue as big as this, since there are a number of samples and it's better to spread the work out. If you'd like to work on this, please pick a specific sample and either mention you're working on it here or open a separate issue for that specifically that we can assign you to. Thanks! :)

@shreya024: If you could pick some specific samples that would be great!

@shreya024
Copy link
Contributor

Just to re-iterate what @jpmedley said, we don't want to assign an issue as big as this, since there are a number of samples and it's better to spread the work out. If you'd like to work on this, please pick a specific sample and either mention you're working on it here or open a separate issue for that specifically that we can assign you to. Thanks! :)

@shreya024: If you could pick some specific samples that would be great!

I would like to work on Action ,alarms , contextMenus and cookies

patrickkettner pushed a commit that referenced this issue May 4, 2023
@shreya024
Action API Readme Added (#884)
50fe851 
* action API readme added

* #798 action api documentation added

* Delete alarms.md
2qg4svr pushed a commit to 2qg4svr/chrome-extensions-samples that referenced this issue Jun 3, 2023
@shreya024 @2qg4svr
Action API Readme Added (GoogleChrome#884)
e2b8bcd 
* action API readme added

* GoogleChrome#798 action api documentation added

* Delete alarms.md
@oliverdunk
Copy link
Member

We are very nearly there, but I think there are a couple remaining (an example is sample.page-redder).

@btwshivam
Copy link

hey, I would love to work on this issue. Assign me!

@oliverdunk
Copy link
Member

@shivam200446, if you could pick specific READMEs you'd like to work on feel free to post here and then open a PR. I'm going to avoid assigning anyone specific for now since depending on how many there are it may make sense to split up the work :)

@Pask00
Copy link
Contributor

Pask00 commented Feb 22, 2024 •
edited

I will work on sample.page-redder and sample.bookmarks!

@oliverdunk
Copy link
Member

Thanks @Pask00! @shivam200446, feel free to take a look and see if that leaves anything - if not, we still need a sample for the chrome.management API. If you want something to work on you could start by opening an issue talking about what that could look like and we can discuss there.

@Pask00 Pask00 mentioned this issue Feb 22, 2024
Merged
@An-Yay An-Yay mentioned this issue Feb 23, 2024
Open
@abrehan2
Copy link

Dear Mr. @jpmedley,

I hope this message finds you well. I have a question regarding the creation of README files for the API samples. Should I prepare a README for each individual sample within the api-samples category, or would a single README covering all samples suffice? Can you please suggest which samples are left to work on. :)

Thank you for your clarification.

Best regards,
Rehan

@oliverdunk
Copy link
Member

Should I prepare a README for each individual sample within the api-samples category, or would a single README covering all samples suffice? Can you please suggest which samples are left to work on. :)

This should be a single README in each sample directory (alongside manifest.json), following the template in the root of the repository. We don't have a full list of samples needing READMEs but here is an example.

As mentioned above please do comment about the specific READMEs you want to look at so we can avoid overlap and leave some for everyone. Do check above to see if one is already claimed.

@abrehan2
Copy link

abrehan2 commented Feb 23, 2024 via email

@oliverdunk
Copy link
Member

Can I work on the one you just mentioned?

Sure (for others, @abrehan2 is going to work on functional-samples/tutorial.tabs-manager) 👍

Note that this is based on https://developer.chrome.com/docs/extensions/get-started/tutorial/popup-tabs-manager so please include a link to it and use it for context around the intended use case :)

@professorabhay
Copy link

professorabhay commented Mar 9, 2024 •
edited

Hey, @oliverdunk! I would like to work on tutorial.getting-started readme file. May I?

@hrmtsh2
Copy link

hrmtsh2 commented Mar 11, 2024

Greetings @oliverdunk and other community members! I would like to work on this issue, as well as potentially write samples for some APIs.
Kindly refer to me the most important ones which need a README and/or samples.
As of now, I am eyeing functional-samples/tutorials.X that lack READMEs. Kindly let me know if I can go ahead (and if anyone else is working on those as well)!

@jpmedley
Copy link
Contributor Author

@hrmtsh2, thank you for the offer of help. @oliverdunk will give you information about creating samples. If you have time for a few READMEs, here's a template to help you get started.

@mahitoburrito
Copy link
Contributor

Hello @oliverdunk and @jpmedley, I would like to work on this issue and complete a couple READMEs and samples. Please let me know if there are any I can get started on!

@bluishhh
Copy link

Greetings @oliverdunk and @jpmedley, I would like to work on this issue. As per my observation, we need READMEs on functional-samples/sample.water_alarm_notification and functional-samples/tutorial.focus-mode, please let me know if i can get started with them.

I am also interested in creating API samples, so please share the instructions and specifications for it as well.

@hrmtsh2
Copy link

hrmtsh2 commented Mar 21, 2024

@bluishhh I have already covered those two in PR #1124. However, I would love to have your suggestions on improving!

@YUNGU23
Copy link

YUNGU23 commented Mar 22, 2024

Hello! I'm currently working on the README files below, so you can avoid duplicating the effort.

  1. api-samples.declarativeNetRequest.url-blocker
  2. api-samples.printing
  3. functional-samples.cookbook.sidepanel-global
  4. functional-samples.cookbook.sidepanel-multiple
  5. functional-samples.cookbook.sidepanel-open
  6. functional-samples.reference.mv3-content-scripts
  7. functional-samples.sample.catifier
  8. functional-samples.sample.co2meter
  9. functional-samples.sample.sidepanel-dictionary
  10. functional-samples.tutorial.google-analytics

@YUNGU23
Copy link

YUNGU23 commented Mar 22, 2024

Hello! I'm currently working on the README files below, so you can avoid duplicating the effort.

  1. api-samples.declarativeNetRequest.url-blocker
  2. api-samples.printing
  3. functional-samples.cookbook.sidepanel-global
  4. functional-samples.cookbook.sidepanel-multiple
  5. functional-samples.cookbook.sidepanel-open
  6. functional-samples.reference.mv3-content-scripts
  7. functional-samples.sample.catifier
  8. functional-samples.sample.co2meter
  9. functional-samples.sample.sidepanel-dictionary
  10. functional-samples.tutorial.google-analytics

I have submitted PR #1129 updating the above READMEs. Your feedback and suggestions would be greatly appreciated. @oliverdunk @jpmedley

@gigimyz
Copy link

gigimyz commented Mar 23, 2024

Hello @oliverdunk and @jpmedley, I would like to work on this issue, please let me know if there are any REAMEs and samples that I can get started and work on!

@mahitoburrito
Copy link
Contributor

Hi! I submitted PR #1138 updating the README for functional-samples.tutorial.reading-time. Any feedback would be appreciated!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement P0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
15 participants
@oliverdunk @jpmedley @Pask00 @mahitoburrito @gigimyz @shreya024 @professorabhay @bluishhh @tusharv01 @ankitoid @abrehan2 @YUNGU23 @btwshivam @hrmtsh2 and others