Hacktoberfest Quickstart

[hxlnt]

Thank you for contributing to webhint as part of Hacktoberfest!

Getting started

• Before contributing to webhint, we recommend getting familiar with the project.
  • Try out the webhint CLI, VS Code extension and/or browser extension.
  • Read the docs! The Contributor Guide contains more detailed information about webhint.

Building the hint repo

Some quick build tips if you're making changes in the hint repo:

1. Run yarn and yarn build after checking out to get everything set up.
2. cd to packages/X for whichever sub-package X you want to work on.
3. Just run yarn build from packages/X for updates. (No need to build the entire repo again.)

What can you help us with?

There are numerous things you can help us with!

• Go through the user guide and let us know if something is not clear or doesn't make sense
• Try setting up webhint in your project following our integration guides and let us know if something is missing or not clear
• Have an idea of something webhint could test for? A service we should integrate with? Open an issue with as much details as possible!
• Take a look at our Hacktoberfest label for issues that have already been identified. You're also welcome to open new issues with your own feature requests or bug reports.
• If you've decided to work on an existing issue, leave a comment on the GitHub issue to let other contributors know. Unless someone has already expressed they want to work on an issue, all are available.

Asking for help

We know that setting up new tools and development environments can be confusing. And docs may be incomplete or incorrect from time to time. If you run into any issues, please reach out to us. We want you to help you help us!

You can reach out to the webhint team by:

• opening an issue on GitHub
• tweeting to @webhintio

Thank you for your interest in webhint! 🙏

[akhileshverma92]

Let's do it 😁