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

Standardise Util Functions Comments #1396

Open
HarshKhandeparkar opened this issue Dec 26, 2019 · 20 comments
Open

Standardise Util Functions Comments #1396

HarshKhandeparkar opened this issue Dec 26, 2019 · 20 comments

Comments

@HarshKhandeparkar
Copy link
Member

@HarshKhandeparkar HarshKhandeparkar commented Dec 26, 2019

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open-source software!

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!

What is to be done?

We are working towards standardizing all the comments in the codebase to make the docs look professional. New developers will get benefitted if we add comments to some of the most commonly used util functions. They are listed below.

  1. pixelSetter.js
  2. getDefaults.js

You will have to update the comments in the above files based on the guidelines mentioned below.

  1. Methods must be described using JSDoc comments
  2. Misc code comments should be inline unless it is a long sentence.
  3. No use of continuous tenses, no pronouns.
  4. No redundant comments.
  5. Each comment should start with an uppercase letter and end with a full stop.

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

📋 Step by Step

  • 🙋 Claim this issue: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!

  • 📝 Modify the file pixelSetter.js

  • 📝 Modify the file getDefaults.js

  • 💾 Commit your changes

  • 🔀 Start a Pull Request. There are two ways how you can start a pull request:

  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

  2. You can also edit files directly in your browser and open a pull request from there.

  • 🏁 Done Ask in comments for a review :)

Please keep us updated

💬 - We encourage contributors to be respectful to the community and provide an update within a week of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need it if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!

If this happens to you, don't sweat it! Grab another open issue.

Is someone else already working on this?

🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.

👥- If someone seems stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

🤔 Questions?

Leave a comment below!

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Dec 26, 2019

@iblalw17

This comment has been minimized.

Copy link

@iblalw17 iblalw17 commented Dec 27, 2019

Can I claim

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Dec 27, 2019

@hedonhermdev

This comment has been minimized.

Copy link

@hedonhermdev hedonhermdev commented Dec 30, 2019

Hey @iblalw17 are you working on this?

@iblalw17

This comment has been minimized.

Copy link

@iblalw17 iblalw17 commented Dec 30, 2019

@hedonhermdev

This comment has been minimized.

Copy link

@hedonhermdev hedonhermdev commented Dec 31, 2019

Ping me if you need any help, maybe I can help you out.

@iblalw17

This comment has been minimized.

Copy link

@iblalw17 iblalw17 commented Dec 31, 2019

@hedonhermdev

This comment has been minimized.

Copy link

@hedonhermdev hedonhermdev commented Dec 31, 2019

Are you using a text editor? If yes then which one? Also which documents are you trying to edit?

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Dec 31, 2019

I think we'll have to add cloning and committing instructions to our FTO template.

@hedonhermdev

This comment has been minimized.

Copy link

@hedonhermdev hedonhermdev commented Dec 31, 2019

Yes that will be a good idea, or linking to a good introduction to Git/GitHub would be nice too, imo.

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Dec 31, 2019

Is there an online article that we can link to?

@hedonhermdev

This comment has been minimized.

Copy link

@hedonhermdev hedonhermdev commented Dec 31, 2019

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Dec 31, 2019

Yeah, nice. Do you want to open a PR that makes these changes to the FTO template?

@hedonhermdev

This comment has been minimized.

Copy link

@hedonhermdev hedonhermdev commented Dec 31, 2019

@udaan42

This comment has been minimized.

Copy link

@udaan42 udaan42 commented Jan 9, 2020

Hello, is this issue still open? I would like to contribute if this issue is open. Thanks.

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Jan 10, 2020

If @iblalw17 is no longer working on this, you can start work on it.

@udaan42

This comment has been minimized.

Copy link

@udaan42 udaan42 commented Jan 13, 2020

Hey @iblalw17. Could you please confirm if you are working on this ? Thanks

@iblalw17

This comment has been minimized.

Copy link

@iblalw17 iblalw17 commented Jan 13, 2020

@iblalw17

This comment has been minimized.

Copy link

@iblalw17 iblalw17 commented Jan 13, 2020

@udaan42

This comment has been minimized.

Copy link

@udaan42 udaan42 commented Jan 14, 2020

Thank you. I will start working on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.