common-vocabulary

Facilitate communication and avoid confusion with canonical terms: share a common vocabulary.

Table of contents

• Installation
• Usage
• API
• Semantic version and CHANGELOG
• Contributing
• License

Installation

Prerequisite software

common-vocabulary is written for Node.js, which must be installed prior to use. Unspecified requires npm, which is used for installing dependencies.

# Install with Unspecified
$ npm i common-vocabulary -g

Usage

You can add, edit, and remove entries directly from a Terminal.

common-vocabulary
# => Creates docs/common-vocabulary.md

API

const CommonVocabulary = require('common-vocabulary')

const cv = new CommonVocabulary()
cv.toHtml()

Semantic version and CHANGELOG

The latest version of common-vocabulary is 1.1.0. View the CHANGELOG for details.

Contributing

We welcome contributions with Pull Requests (PRs)!

Contributions in the form of GitHub pull requests are welcome. Before embarking on a significant change, please adhere to the following guidelines:

1. Create an issue—e.g., a defect ("bug") report or a feature request—to propose changes.

   Exceptions:

   If you're working on documentation and fixing something simple like a typo or an easy bug, go ahead and make a pull request.

2. Follow the CONTRIBUTING guidelines.

   Why:

   Standards and guidelines make communication easier. If you're willing and able to program—or want to learn how— following the guidelines will increase the likelihood of adding your changes to the software product.

3. Read the Code of Conduct.

   Why:

   It's more fun when everybody's friendly and respectful.

4. Make a pull request when you're ready for other to review your changes (or you get stuck somewhere).

   PR novices:

   :raising_hand: Never created a pull request? No problem. :free: Take this free online training. (It even covers most of the conventions in the CONTRIBUTING guidelines!)

License

MIT © commonality.

Graphic art by icons8.