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

Docs: References correct config file name #12885

Merged
merged 1 commit into from Feb 25, 2020
Merged

Conversation

pckilgore
Copy link
Contributor

@pckilgore pckilgore commented Feb 7, 2020

Prerequisites checklist

  • I have read the contributing guidelines.
  • The team has reached consensus on the changes proposed in this pull request. If not, I understand that the evaluation process will begin with this pull request and won't be merged until the team has reached consensus.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

From eslint/archive-website#693

According to the configuration.md page, the .eslintrc file format has been deprecated, and the --init option will generate either a .yml, .js, or .json file depending on what you pick in the initialization wizard.

This commit syncs the getting-started instructions with the configuration instructions.

Is there anything you'd like reviewers to focus on?

{} syntax may be confusing, I'm certainly not wedded to it but I am used to it.

From eslint/archive-website#693

According to the `configuration.md` page, the `.eslintrc` file format has been deprecated, and the `--init` option will generate either a `.yml`, `.js`, or `.json` file depending on what you pick in the initialization wizard.

This commit syncs the getting-started instructions with the configuration instructions.
@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Feb 7, 2020
Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@kaicataldo kaicataldo added documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Feb 8, 2020
@kaicataldo
Copy link
Member

Two things:

  1. Can you confirm you have read the contributing docs?
  2. I'm not sure why the commit message is failing...Does someone else see what's wrong?

@pckilgore
Copy link
Contributor Author

Read the guidelines, forgot to check. If you don't know why your linter doesn't like my commit message then I'm probably not going to be helpful other than to point out that it's probably not a helpful rule 🙃

Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why the commit message is failing (might be an issue with the bot). LGTM.

@mdjermanovic
Copy link
Member

I think it's failing because the commit message starts with a space.

@kaicataldo kaicataldo changed the title Docs: References correct config file name Docs: References correct config file name Feb 25, 2020
@kaicataldo
Copy link
Member

Ha, good catch. GitHub doesn't render the whitespace, but it looks like that is the case here. Thanks!

@kaicataldo kaicataldo merged commit f479f6f into eslint:master Feb 25, 2020
@kaicataldo
Copy link
Member

Thanks for contributing!

montmanu pushed a commit to montmanu/eslint that referenced this pull request Mar 4, 2020
From eslint/archive-website#693

According to the `configuration.md` page, the `.eslintrc` file format has been deprecated, and the `--init` option will generate either a `.yml`, `.js`, or `.json` file depending on what you pick in the initialization wizard.

This commit syncs the getting-started instructions with the configuration instructions.
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Aug 25, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Aug 25, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants