Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (39 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 2.41 KB

Contributing

Issue

  1. Check that the issue has not already been reported (search here).
  2. Document the steps that were followed that resulted in an error.
  3. Document any error messages that were printed in the server log (nicest dev or pm2 logs).
  4. Document any error messages that were printed in the browser log. (chrome, firefox, edge).
  5. Ensure any error messages or code snippets are noted with a fenced code block.
  6. Screenshots for UI errors are helpful.

Pull Request

  1. Commit code and open a Pull Request

  2. Ensure that code passes static analysis

    • Test results are reported to PR status
    • Tests can be run locally using npm test

  3. Get a code review

    • Any repository collaborator can approve a pull request
    • A reviewer can approve a PR by writing a comment starting with Approved, LGTM, or :shipit:
    • A review can reject a PR by writing a comment starting with Rejected

  4. Merge

    • Any collaborator can merge an approved pull request
    • Your code is now part of the project 😄

Developer Installation

  1. Install Node JS
  2. Install Mongo Db
  3. Install Node Gyp dependencies
  4. Install Git
  5. Open a Terminal or Command Line
  6. Run git clone https://github.com/ChristianMurphy/nicest
  7. Open folder cd nicest
  8. Install and Link npm link .
  9. Setup Nicest

How-To