README update #9488

OlaoluwaM · 2021-04-09T23:35:38Z

I hope you don't mind, but I took the liberty to make some changes to wording that would make things more succinct and clearer. I also made certain items links because the way they were written kind of positioned them in a way that makes more sense to link them. Please let me know if there are any problems and I'll be sure to fix them. Thank you for this opportunity. I went through the docs and you guys are doing awesome things.

Fixes #9479 (<=== Add issue number here)

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

PR is descriptively titled 📑 and links the original issue above 🔗
tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with rake test
code is in uniquely-named feature branch and has no merge conflicts 📁
screenshots/GIFs are attached 📎 in case of UI updation
ask @publiclab/reviewers for help, in a comment below

We're happy to help you get this ready -- don't be afraid to ask for help, and don't be discouraged if your tests fail at first!

If tests do fail, click on the red X to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software

Thanks!

I hope you don't mind, but I took the liberty to make some changes to wording that would make things more succinct and clearer. I also made certain items links because the way they were written kind of positioned them in a way that makes more sense to link them. Please let me know if there are any problems and I'll be sure to fix them. Thank you for this opportunity. I went through the docs and you guys are doing awesome things.

welcome · 2021-04-09T23:35:40Z

Thanks for opening this pull request! This space is protected by our Code of Conduct - and we're here to help.
Dangerbot will test out your code and reply in a bit with some pointers and requests.
Also please refer here for installation help 💿
There may be some errors, but don't worry! We'll work through them with you! 👍🎉😄

gitpod-io · 2021-04-09T23:35:41Z

codecov · 2021-04-09T23:41:51Z

Codecov Report

❗ No coverage uploaded for pull request base (main@b051096). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head 9ffac2c differs from pull request most recent head a49c402. Consider uploading reports for the commit a49c402 to get more accurate results

@@           Coverage Diff           @@
##             main    #9488   +/-   ##
=======================================
  Coverage        ?   81.50%           
=======================================
  Files           ?       98           
  Lines           ?     5938           
  Branches        ?        0           
=======================================
  Hits            ?     4840           
  Misses          ?     1098           
  Partials        ?        0

sahilsaha7773

Great work @OlaoluwaM! Looks good to me, thanks for opening this PR!

OlaoluwaM · 2021-04-10T07:19:58Z

Great!! Thank you so much. So what do I do next 😅?

sahilsaha7773 · 2021-04-10T08:47:31Z

Great!! Thank you so much. So what do I do next 😅?

Please wait for the project maintainers to review the PR. 😄

README.md

NishantJawla · 2021-04-10T14:56:09Z

I hope you don't mind, but I took the liberty to make some changes to wording that would make things more succinct and clearer. I also made certain items links because the way they were written kind of positioned them in a way that makes more sense to link them. Please let me know if there are any problems and I'll be sure to fix them. Thank you for this opportunity. I went through the docs and you guys are doing awesome things.

Fixes #9479 (<=== Add issue number here)

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

[ ✔] PR is descriptively titled 📑 and links the original issue above 🔗

tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with rake test

[ ✔] code is in uniquely-named feature branch and has no merge conflicts 📁

screenshots/GIFs are attached 📎 in case of UI updation

ask @publiclab/reviewers for help, in a comment below

We're happy to help you get this ready -- don't be afraid to ask for help, and don't be discouraged if your tests fail at first!

If tests do fail, click on the red X to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software

Thanks!

hey! @OlaoluwaM please remove those "✔️" by editing. Save it then later tick when the box appears

OlaoluwaM · 2021-04-10T15:02:00Z

@NishantJawla Done!

OlaoluwaM · 2021-04-11T12:37:55Z

So is there anything else I need to do 🙂

NishantJawla · 2021-04-11T13:53:33Z

So is there anything else I need to do 🙂

Just wait for a collaborator to review this PR

cesswairimu

Tremendous!!! thanks a lot @OlaoluwaM for going through the doc and helping improve it...please let me know what you think of my suggestions. Thanks again for working on this

cesswairimu · 2021-04-12T11:10:04Z

README.md

@@ -184,18 +181,19 @@ Adding `bundle exec` ensures you're using the version of passenger you just inst

 ## Reply-by-email

-Public Lab now supports reply by email to comment feature. For more details regarding it go to the [email documentation](https://github.com/publiclab/plots2/blob/main/doc/EMAIL.md)
+Public Lab now supports reply by email to comment features. For more details, go to the [email documentation](https://github.com/publiclab/plots2/blob/main/doc/EMAIL.md)


I believe we would like to keep it as singular because the "reply by email comment" is one feature..what do you think?

Ohh, that makes a lot of sense. If that's the case wouldn't be better to string them together like "reply-by-email-to-comment" feature? Or put them in quotes so anyone reading knows that they go together

I agree, the quotes would make the phrase better. Thanks

How do I update the PR?

Update the changes from here https://github.com/OlaoluwaM/plots2/tree/patch-1 and commit, the commit will appear over here too. thanks

README.md

OlaoluwaM · 2021-04-12T14:05:12Z

For the last bit (change), a colon would work, but the problem is the "and a wiki" part. Colons are primarily used to tack on more information or an explanation onto the end of an independent clause. You can check out this site for more info

However, I could be getting something wrong, the "group research blog," is it both the "research notes" and "wiki" or just "research notes"? If it is the former then yes, a colon would be appropriate.

If it is the latter, then the "what we call 'research notes'" part is more of an aside than a component of the sentence. I say aside because it exists to add more information, not necessarily to make the sentence make sense; if we were to remove it no one would notice and the sentence would still convey meaning. Therefore, I tried to demarcate it that way with the dashes, but commas would work equally as well. In fact, commas would have been better since they are more common.

codeclimate · 2021-04-15T13:56:31Z

Code Climate has analyzed commit a49c402 and detected 0 issues on this pull request.

View more on Code Climate.

cesswairimu

thanks again @OlaoluwaM 🎉

welcome · 2021-04-15T16:10:33Z

Congrats on merging your first pull request! 🙌🎉⚡️
Your code will likely be published to PublicLab.org in the next few days, but first it will be published to https://stable.publiclab.org/ (it will take some minutes for this to load, and until then you may see logs from the build process). Please test out your work on this testing server and report back with a comment that all has gone well!
Do join our weekly check-in to share your this week goal and the awesome work you did 😃. Please find the link to our latest check-in here 📝
Now that you've completed this, you can help someone else take their first step!
Reach out to someone else working on theirs on Public Lab's code welcome page (where you'll now be featured as a recent contributor!). Thanks!

Help others take their first step

Now that you've merged your first pull request, you're the perfect person to help someone else out with this challenging first step. 🙌

https://code.publiclab.org

Try looking at this list of `first-timers-only` issues, and see if someone else is waiting for feedback, or even stuck! 😕

People often get stuck at the same steps, so you might be able to help someone get unstuck, or help lead them to some documentation that'd help. Reach out and be encouraging and friendly! 😄 🎉

Read about how to help support another newcomer here, or find other ways to offer mutual support here.

* README update I hope you don't mind, but I took the liberty to make some changes to wording that would make things more succinct and clearer. I also made certain items links because the way they were written kind of positioned them in a way that makes more sense to link them. Please let me know if there are any problems and I'll be sure to fix them. Thank you for this opportunity. I went through the docs and you guys are doing awesome things. * fix(docs): quoted and made word singular

sahilsaha7773 approved these changes Apr 10, 2021

View reviewed changes

NishantJawla suggested changes Apr 10, 2021

View reviewed changes

README.md Show resolved Hide resolved

NishantJawla approved these changes Apr 10, 2021

View reviewed changes

cesswairimu requested changes Apr 12, 2021

View reviewed changes

fix(docs): quoted and made word singular

a49c402

cesswairimu approved these changes Apr 15, 2021

View reviewed changes

cesswairimu merged commit 0ed4fc8 into publiclab:main Apr 15, 2021

OlaoluwaM deleted the patch-1 branch April 15, 2021 17:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README update #9488

README update #9488

OlaoluwaM commented Apr 9, 2021 •

edited

Loading

welcome bot commented Apr 9, 2021

gitpod-io bot commented Apr 9, 2021 •

edited

Loading

codecov bot commented Apr 9, 2021 •

edited

Loading

sahilsaha7773 left a comment

OlaoluwaM commented Apr 10, 2021

sahilsaha7773 commented Apr 10, 2021

NishantJawla commented Apr 10, 2021

OlaoluwaM commented Apr 10, 2021

OlaoluwaM commented Apr 11, 2021 •

edited

Loading

NishantJawla commented Apr 11, 2021

cesswairimu left a comment

cesswairimu Apr 12, 2021

OlaoluwaM Apr 12, 2021

cesswairimu Apr 12, 2021

OlaoluwaM Apr 12, 2021

cesswairimu Apr 12, 2021 •

edited

Loading

OlaoluwaM Apr 15, 2021

OlaoluwaM commented Apr 12, 2021

codeclimate bot commented Apr 15, 2021

cesswairimu left a comment •

edited

Loading

welcome bot commented Apr 15, 2021

README update #9488

README update #9488

Conversation

OlaoluwaM commented Apr 9, 2021 • edited Loading

welcome bot commented Apr 9, 2021

gitpod-io bot commented Apr 9, 2021 • edited Loading

codecov bot commented Apr 9, 2021 • edited Loading

Codecov Report

sahilsaha7773 left a comment

Choose a reason for hiding this comment

OlaoluwaM commented Apr 10, 2021

sahilsaha7773 commented Apr 10, 2021

NishantJawla commented Apr 10, 2021

OlaoluwaM commented Apr 10, 2021

OlaoluwaM commented Apr 11, 2021 • edited Loading

NishantJawla commented Apr 11, 2021

cesswairimu left a comment

Choose a reason for hiding this comment

cesswairimu Apr 12, 2021

Choose a reason for hiding this comment

OlaoluwaM Apr 12, 2021

Choose a reason for hiding this comment

cesswairimu Apr 12, 2021

Choose a reason for hiding this comment

OlaoluwaM Apr 12, 2021

Choose a reason for hiding this comment

cesswairimu Apr 12, 2021 • edited Loading

Choose a reason for hiding this comment

OlaoluwaM Apr 15, 2021

Choose a reason for hiding this comment

OlaoluwaM commented Apr 12, 2021

codeclimate bot commented Apr 15, 2021

cesswairimu left a comment • edited Loading

Choose a reason for hiding this comment

welcome bot commented Apr 15, 2021

OlaoluwaM commented Apr 9, 2021 •

edited

Loading

gitpod-io bot commented Apr 9, 2021 •

edited

Loading

codecov bot commented Apr 9, 2021 •

edited

Loading

OlaoluwaM commented Apr 11, 2021 •

edited

Loading

cesswairimu Apr 12, 2021 •

edited

Loading

cesswairimu left a comment •

edited

Loading