Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 2.39 KB

Having problems installing NodeBB?

Chances are somebody has run into this problem before. After consulting our documentation, please head over to our community support forum for advice.

Issues & Bugs

Thanks for reporting an issue with NodeBB! Please follow these guidelines in order to streamline the debugging process. The more guidelines you follow, the easier it will be for us to reproduce your problem.

In general, if we can't reproduce it, we can't fix it!

Important

If you believe you have identified a security vulnerability with NodeBB, report it as soon as possible via email to [email protected]. A member of the NodeBB security team will respond to the issue. Please do not post it to the public bug tracker.

Try the latest version of NodeBB

There is a chance that the issue you are experiencing may have already been fixed.

Provide the NodeBB version number and git hash

You can find the NodeBB version number in the Admin Control Panel (ACP), as well as the first line output to the shell when running NodeBB

info: NodeBB v0.5.2-dev Copyright (C) 2013-2014 NodeBB Inc.
info: This program comes with ABSOLUTELY NO WARRANTY.
info: This is free software, and you are welcome to redistribute it under certain conditions.
info: 
info: Time: Tue Oct 07 2014 20:25:20 GMT-0400 (EDT)

If you are running NodeBB via git, it is also helpful to let the maintainers know what commit hash you are on. To find the commit hash, execute the following command:

$ cd /path/to/my/nodebb
$ git rev-parse HEAD

If you have downloaded the .zip or .tar.gz packages from GitHub (or elsewhere), please let us know.

Attempt to use git bisect

If you have installed NodeBB via GitHub clone, are familiar with utilising git, and are willing to help us narrow down the specific commit that causes a bug, consider running git bisect.

A full guide can be found here: Debugging with Git/Binary Search

Submitting a Pull Request to NodeBB?

First of all, thank you! Please consider this style guide when submitting your changes. Also, please join our community to meet other NodeBB developers and designers :)