community-toolbox
community-toolbox copied to clipboard
Resolve linting errors
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.
Problem
πSolution
-
[ ] π 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
// install ESLint
$ npm i -g eslint
// navigate and run linter
$ cd community-toolbox && eslint --fix .
// format code to fix linting errors
// you can also add various configuration rules by running `eslint --init` which create .eslintrc file.
After the errors are fixed, proceed as specified below.
-
[ ] πΎ Commit your changes
-
[ ] π Start a Pull Request. There are two ways how you can start a pull request:
-
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.
-
You can also edit files directly in your browser and open a pull request from there.
- [ ] π Done Ask in comments for a review :)
π€β Questions?
Leave a comment below!
Is someone else already working on this?
We encourage you to link to this issue by mentioning the issue # in your pull request, so we can see if someone's already started on it. If someone seem stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!
Thanks for opening your first issue here! Please follow the issue template to help us help you πππ If you have screenshots to share demonstrating the issue, that's really helpful! πΈ You can make a gif too!
@jywarren Can you please add appropriate FTO labels to this issue.
Can I take this up? :)
If so, should all folders (except dist
ofcourse) be linted or only src
?
Which eslintrc
configuration should be used or is the eslint:recommended
fine?
Hey, can I possibly on the solution of this issue? :)
Hi @debck, can we make it work by installing it as a dev-dependency? Also, please put the code changes in the DIFF markdown so that it becomes easy for anyone to follow the instructions regarding code updations in the project.
@arnoschutijzer please go ahead if you would like to contribute. If you are not able to work on this for now, @mats-codes can go ahead.
Thanks, everyone.
Let's switch it around. If @mats-codes is still available for this issue he can go for it, if not I can take it up.
@arnoschutijzer go ahead, I'll get involved somewhere else then :)
Alright, so I was working on adding a script to package.json
and linting config based on eslint:recommended
. (see here)
I'm just not sure which files to lint and if the recommended config is okay. :)
is this issue claimed? can I try this?
sure, go for it!
@debck @Rishabh570 , Please review my PR and let me know if any more changes are needed.