<commit_before># Joyent Engineering Guide

Repository: <<EMAIL>:eng.git>
Browsing: <https://mo.joyent.com/eng>
Who: <NAME>, <NAME>
Docs: <https://head.no.de/docs/eng>
Tickets/bugs: <https://devhub.joyent.com/jira/browse/TOOLS>


# Overview

This repo serves two purposes: (1) It defines the guidelines and best
practices for Joyent engineering work (this is the primary goal), and (2) it
also provides boilerplate for an SDC project repo, giving you a starting
point for many of the suggestion practices defined in the guidelines. This is
especially true for node.js-based REST API projects.

Start with the guidelines: <https://head.no.de/docs/eng>


# Repository

    deps/           Git submodules and/or commited 3rd-party deps should go
                    here. See "node_modules/" for node.js deps.
    docs/           Project docs (restdown)
    lib/            Source files.
    node_modules/   Node.js deps, either populated at build time or commited.
                    See Managing Dependencies.
    pkg/            Package lifecycle scripts
    smf/manifests   SMF manifests
    smf/methods     SMF method scripts
    test/           Test suite (using node-tap)
    tools/          Miscellaneous dev/upgrade/deployment tools and data.
    Makefile
    package.json    npm module info (holds the project version)
    README.md


# Development

To run the boilerplate API server:

    git clone <EMAIL>:eng.git
    cd eng
    git submodule update --init
    make all
    node server.js

To update the guidelines, edit "docs/index.restdown" and run `make docs`
to update "docs/index.html".

Before commiting/pushing run `make prepush` and, if possible, get a code
review.



# Testing

    make test

If you project has setup steps necessary for testing, then describe those
here.



# Other Sections Here

Add other sections to your README as necessary. E.g. Running a demo, adding
development data.



# TODO

Remaining work for this repo:

- any "TODO" or "XXX" in the repo
- review from engineering group
- [Trent] Finish the restdown "public" dir and other work as discussed with
  Philip. `git rm docs/media/css`
- Give a little starter guide on using this repo as a starter template for the
  new repos (for NAPI, CNAPI, FWAPI, DAPI, Workflow API, ZAPI). Include
  getting on mo.joyent.com and head.no.de/docs for this.
- Should we spec JIRA projects for the new APIs?
- Add the node/npm local build support a la Amon and DSAPI. I.e. deps/node
  and deps/npm git submodules and build handling in the Makefile.

<commit_msg>update readme to be about this repo instead of eng.git<commit_after># Node.js Clients for SmartDataCenter Services

Repository: <<EMAIL>:node-sdc-clients.git>
Browsing: <https://mo.joyent.com/node-sdc-clients>
Who: <NAME> and others
Tickets: <https://devhub.joyent.com/jira/browse/TOOLS> or the specific service


# Overview

Node.js client libraries for the various SDC REST API services.



# Repository

    lib/            Source files.
    tst/            Test suite (using whiskey)
    Makefile
    package.json    npm module info (holds the project version)
    README.md
    CHANGES.md      changelog


# Development

Before commiting/pushing run `make prepush` and, if possible, get a code
review.



# Testing

    make test

TODO: describe setup steps and issues running all these test suites.




{'fraction_non_alphanumeric': 0.0746491489997014, 'fraction_numerical': 0.0008957897879964168, 'mean_word_length': 2.9411764705882355, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 17, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4450626', 'n_tokens_mistral': 1045, 'n_tokens_neox': 975, 'n_words': 411}