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

Adding test instructions into CONTRIBUTING.md #57

Closed
Immutablevoid opened this issue Nov 6, 2019 · 11 comments
Closed

Adding test instructions into CONTRIBUTING.md #57

Immutablevoid opened this issue Nov 6, 2019 · 11 comments
Assignees
Labels
type: documentation (docs) Improvements or additions to documentation

Comments

@Immutablevoid
Copy link
Contributor

Immutablevoid commented Nov 6, 2019

Add instruction npm test, npm run eslint, npm run eslint-fix to CONTRIBUTING.md. See #55 for more information about the testing infrastructure.

@Immutablevoid Immutablevoid added the type: documentation (docs) Improvements or additions to documentation label Nov 6, 2019
@cindyorangis
Copy link
Contributor

PR #55 has merged; closing this issue.

@ragnarokatz
Copy link
Contributor

@ImmutableBox I don't believe this documentation issue has been completed, please correct me if I'm wrong.

@ragnarokatz
Copy link
Contributor

Please rename the section into "The list of things must be done by a contributor before filing a PR", so that it includes jest, npm test, eslint and whatever might be added in the future.

@Immutablevoid
Copy link
Contributor Author

@ImmutableBox I don't believe this documentation issue has been completed, please correct me if I'm wrong.

Yup, you are correct. This hasn't been implemented yet.

@Immutablevoid
Copy link
Contributor Author

Please rename the section into "The list of things must be done by a contributor before filing a PR", so that it includes jest, npm test, eslint and whatever might be added in the future.

The CONTRIBUTING.md already has a list of things to be done (Setting up Redis, npm install), this issue is only suppose to add testing instructions.

@Immutablevoid Immutablevoid self-assigned this Nov 7, 2019
@ragnarokatz
Copy link
Contributor

ragnarokatz commented Nov 9, 2019

@ImmutableBox @humphd
If you don't mind, can we please put this ticket on high priority and get it done/merged ASAP? I'm starting to see examples such as #76 and #106 where people are spending time fixing other people's code because the original author didn't run the linting/ tests before PR creation/subsequent merging.

Please name the section in CONTRIBUTING.md The list of things must be done by a contributor before filing a PR, and make it bold/stand out.
NOTE: This has nothing to do with project setup. This only has to do with the list of things that needs to be done EVERY SINGLE TIME before a PR is filed. please emphasize this in the CONTRIBUTING.md doc.

@humphd
Copy link
Contributor

humphd commented Nov 9, 2019

We really need to get #97 landed, which will stop this from happening, by running every PR through eslint/tests. cc @kartik-budhiraja.

But I agree, someone should get a PR up that adds these instructions. You're welcome to get the ball rolling if you want, since you already have some text above.

@Immutablevoid
Copy link
Contributor Author

Ill get this out of our hairs. Just give me a couple of minutes.

@kartik-budhiraja
Copy link
Contributor

@ImmutableBox would appreciate it if you could review PR #97 so we could get the pipeline up and running.

@Immutablevoid
Copy link
Contributor Author

Immutablevoid commented Nov 9, 2019

@ImmutableBox would appreciate it if you could review PR #97 so we could get the pipeline up and running.

Sure. Let me finish this first.

@Immutablevoid
Copy link
Contributor Author

Resolve in #114.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

6 participants