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

Improve the documentation for no-restricted-modules #9437

Closed
kaicataldo opened this Issue Oct 14, 2017 · 6 comments

Comments

Projects
None yet
4 participants
@kaicataldo
Member

kaicataldo commented Oct 14, 2017

The current documentation for no-restricted-modules would benefit from more information and about its configuration and clearer examples of what its configuration options do. A good place to start would be to emulate the documentation for the similar no-restricted-imports rule.

@vibss2397

This comment has been minimized.

Show comment
Hide comment
@vibss2397

vibss2397 Oct 14, 2017

Contributor

@kaicataldo i would definitely like to help,this will be my first contribution though so can i get a more clear idea on how to submit this.

Contributor

vibss2397 commented Oct 14, 2017

@kaicataldo i would definitely like to help,this will be my first contribution though so can i get a more clear idea on how to submit this.

@platinumazure

This comment has been minimized.

Show comment
Hide comment
@platinumazure

platinumazure Oct 14, 2017

Member

@vibss2397 Awesome, we would love to see what you come up with! 😄 Start by taking a quick look at our contributing guide, and please feel free to post here or come by our Gitter chat if you run into issues.

Member

platinumazure commented Oct 14, 2017

@vibss2397 Awesome, we would love to see what you come up with! 😄 Start by taking a quick look at our contributing guide, and please feel free to post here or come by our Gitter chat if you run into issues.

@kaicataldo

This comment has been minimized.

Show comment
Hide comment
@kaicataldo

kaicataldo Oct 16, 2017

Member

@vibss2397 Thanks for looking at this! As @platinumazure said, please don't hesitate to reach out.

Member

kaicataldo commented Oct 16, 2017

@vibss2397 Thanks for looking at this! As @platinumazure said, please don't hesitate to reach out.

@vibss2397

This comment has been minimized.

Show comment
Hide comment
@vibss2397

vibss2397 Oct 16, 2017

Contributor

@platinumazure @kaicataldo just one last thing do i have to submit the change as a rule change template or the way it is written in the docs or website

Contributor

vibss2397 commented Oct 16, 2017

@platinumazure @kaicataldo just one last thing do i have to submit the change as a rule change template or the way it is written in the docs or website

@kaicataldo

This comment has been minimized.

Show comment
Hide comment
@kaicataldo

kaicataldo Oct 16, 2017

Member

@vibss2397 Sorry, I'm not sure I understand the question - mind explaining? The file to edit would be https://github.com/eslint/eslint/blob/master/docs/rules/no-restricted-modules.md, and to submit a PR you would follow the steps outlined in the Contributing documentation.

Member

kaicataldo commented Oct 16, 2017

@vibss2397 Sorry, I'm not sure I understand the question - mind explaining? The file to edit would be https://github.com/eslint/eslint/blob/master/docs/rules/no-restricted-modules.md, and to submit a PR you would follow the steps outlined in the Contributing documentation.

vibss2397 added a commit to vibss2397/eslint that referenced this issue Oct 21, 2017

@vibss2397

This comment has been minimized.

Show comment
Hide comment
@vibss2397

vibss2397 Oct 21, 2017

Contributor

hey sorry for making this change so late,was busy,however do check it and tell if it was the thing you required.

Contributor

vibss2397 commented Oct 21, 2017

hey sorry for making this change so late,was busy,however do check it and tell if it was the thing you required.

vibss2397 added a commit to vibss2397/eslint that referenced this issue Oct 21, 2017

vibss2397 added a commit to vibss2397/eslint that referenced this issue Oct 23, 2017

vibss2397 added a commit to vibss2397/eslint that referenced this issue Oct 23, 2017

@gyandeeps gyandeeps closed this in bb6e60a Oct 27, 2017

@eslint eslint bot locked and limited conversation to collaborators Apr 26, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.