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

Discussion: Update .rubocop_shopify_styleguide.yml #8646

Closed
5 tasks
RuthNjeri opened this issue Oct 20, 2020 · 12 comments
Closed
5 tasks

Discussion: Update .rubocop_shopify_styleguide.yml #8646

RuthNjeri opened this issue Oct 20, 2020 · 12 comments
Labels
first-timers-only They need to be well-formatted using the First-timers_Issue_Template.

Comments

@RuthNjeri
Copy link
Contributor

When I run rubocop -a app/controllers/notes_controller.rb or rubocop -a <any other file> I receive a series of errors from that show that the .rubocop_shopify_styleguide.yml has obsolete configurations.

Should it be updated?

Screenshot 2020-10-20 at 21 46 14

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 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!

  • 📝 Update the file rubocop_shopify_styleguide.yml in the PLOT2 repository (press the little pen Icon) and update any errors that show that rubocop_shopify_styleguide.yml contains deprecated lines of configuration.

See this page for some help in taking your first steps!

  • 💾 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 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!

@RuthNjeri RuthNjeri added the first-timers-only They need to be well-formatted using the First-timers_Issue_Template. label Oct 20, 2020
@RuthNjeri
Copy link
Contributor Author

Tagging @jywarren and @cesswairimu in the discussion above.

@h20190907
Copy link

Please assign this issue to me. I am new to the open-source community and looking forward to opportunities to contribute. Thanks in advance!

@nk183
Copy link
Contributor

nk183 commented Oct 21, 2020

can I work on this issue ?

@RuthNjeri
Copy link
Contributor Author

Hi @nk183, the issue hasn't been given a "go ahead" yet by @jywarren and @cesswairimu, it's still a discussion..
If approved, @h20190907 will be assigned since he reached out first...however, in the meantime, both of you can mention that you are looking for an issue to work on here

@cesswairimu
Copy link
Collaborator

cesswairimu commented Oct 21, 2020

Hey all, thanks @RuthNjeri for opening this. Yeah we can try it out with one file see how travis and codeclimate will behave.

@h20190907 you can go ahead, lets start with file Ruth suggested notes_controller alone and create a PR for that.
@nk183 you could keep an eye on how this goes if successful we can move to other files.

Thanks everyone

@h20190907
Copy link

Thanks a lot, @cesswairimu @RuthNjeri, I will start working on this, and will keep posting the updates here

@ghost
Copy link

ghost commented Oct 22, 2020

@RuthNjeri what exactly is rubocorp?

@RuthNjeri
Copy link
Contributor Author

RuthNjeri commented Oct 22, 2020

Hi @karenefereyan, Rubocop is usually used to format the code, or ensure that you are using the correct coding standards usually described in a config file within the app files for example rubocop.yml

If for instance, you want to autocorrect a particular file, maybe the indentation is off or your method names are wrong, you can run Rubocop on that file and it will correct what it can for you or share warnings that you need to correct manually.. you can read more about it here it is usually installed as a gem.

@ghost
Copy link

ghost commented Oct 24, 2020

Hi @karenefereyan, Rubocop is usually used to format the code, or ensure that you are using the correct coding standards usually described in a config file within the app files for example rubocop.yml

If for instance, you want to autocorrect a particular file, maybe the indentation is off or your method names are wrong, you can run Rubocop on that file and it will correct it for you.. you can read more about it here it is usually installed as a gem.

Nice. Similar to lint rules in yarn, right? Thanks for explaining

@noi5e
Copy link
Contributor

noi5e commented Sep 14, 2021

Thanks so much for opening this @RuthNjeri, I also discovered this a few months back when I was trying to lint files!

Tagging @jywarren and @Tlazypanda as well to put this on their radar as a potential source of FTOs that's very useful to the repo.

@kunmi02
Copy link
Contributor

kunmi02 commented Apr 5, 2022

@TildaDares and @jywarren I think this pull request #10877 actually closed this issue. I think it is safe to close this issue

@TildaDares
Copy link
Member

Resolved in #10877

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
first-timers-only They need to be well-formatted using the First-timers_Issue_Template.
Projects
None yet
Development

No branches or pull requests

7 participants