Eslint-plugin-jsdoc: Create a CONTRIBUTING.md file

Created on 27 Mar 2019  路  3Comments  路  Source: gajus/eslint-plugin-jsdoc

It would be a lot easier for someone to contribute if there was a document that explained some basic aspects of the project.

  1. How to test changes locally (npm link)
  2. How to build the project
  3. Coding standards
  4. Are tests needed? If so, how to write them.
  5. Requirements for PR

Of course, most of these can just be links to other resources, like npm link. The point of this document would allow someone who knows javascript, but doesn't necessarily know this project, how to contribute.

This document is not a guide of how to write rules for eslint.

documentation

Most helpful comment

It should be called CONTRIBUTING.md

All 3 comments

It should be called CONTRIBUTING.md

Adding a tentative CONTRIBUTING.md file for #180.

Welcome your feedback!

Fixed by #239.

Was this page helpful?
0 / 5 - 0 ratings