馃帀 Thanks for your interest in the PostGeekEngine 馃帀
We are currently setting up and getting things started let us know if there is anything missing let us know and we'll gladly address the issue as soon as we can!
Welcome to the contribution guidelines, thanks for stopping by! If you're interested in contributing to the project; I suggest you start by looking at any open issues that might spark your interest.
Getting Started
Running the project
Generating the documentation
Unit Tests
If you have not done so already please read our code of conduct
Installing the project's dependencies
npm install
Running the project
npm run start
We use esdoc for our project's documentation. The dream is to hit 100% code coverage, and we require that every pull request have documentation to describe what each method and class does.
Generating the esdoc files
npm run docs
We use jest for all our unit testing needs. We require that new functionality be tested to a minimum to make sure it respects the COS (conditions of success) defined in the issue.
Running the project's unit tests
npm run test