Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.73 KB
Raw

Contributing to PM2

Fire an issue

When you got an issue by using pm2, you will fire an issue on github. We'll be glad to help or to fix it but the more data you give the most fast it would be resolved. Please try following these rules it will make the task easier for you and for us:

1. Search through issues if it hasn't been resolved yet

2. Make sure that you provide following informations:

  • pm2 version pm2 --version
  • nodejs version node --version
  • operating system
  • head -n 50 ~/.pm2/pm2.log output

3. Provide details about your issue:

  • What are the steps that brought me to the issue?
  • How may I reproduce this? (this isn't easy in some cases)
  • Are you using a cluster module? Are you trying to catch SIGTERM signals? With code if possible.

4. Think global

If your issue is too specific we might not be able to help and stackoverflow might be a better place to seak for an answer

5. Be clear and format issues with markdown

Note that we might understand english, german and french

6. Use debugging functions:

DEBUG=pm2:* PM2_DEBUG=true ./bin/pm2 --no-daemon start my-buggy-thing.js

If your issue is flagged as need data be sure that there won't be any upgrade unless we can have enough data to reproduce.

Pull-Requests

  1. Fork pm2
  2. Create a different branch to do your fixes/improvements if it's core-related.
  3. Please add unit tests! There are lots of tests take examples from there!
  4. Try to be as clear as possible in your commits
  5. Pull request on the development branch from your fork

We 'd like to keep our master branch as clean as possible, please avoid PRs on master, thanks!