madhums / madhums/node-notifier

Sending is disabled in dev or test

Open
#3 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
84
Forks
12
PR merge metrics
No merged PRs in 30d

Description

Hello,

thank you for creating this module.

Inside notifier.js you write:
// as you don't want to send emails while development or testing
and then you disable sending for NODE_ENV = test or development.

I think it isn't a good idea to disable sending in development mode and if you do so you should mention this in big red letters inside the docs as people like me spend hours to figure out why no e-mails arive.

I would suggest adding a dry-run config option and default it to true. So people can decide.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in notifier.js and inspect how NODE_ENV currently disables sending. Check the existing documentation for any configuration guidance, then define where a dry-run option belongs and document its default and effect. Done means the option controls whether messages are sent and the development behavior is clearly documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.