Skip to content

Commit

Permalink
Spelling and grammar check for contrib-notes (hyperledger-archives#859)
Browse files Browse the repository at this point in the history
* spellcheck on guidelines and logging

* spellcheck on getting-started and ide-setup

* spellcheck on misc, QA and raising-issues

* spellcheck for weekly-qa
  • Loading branch information
BjornvdLaan authored and Simon Stone committed May 5, 2017
1 parent 8f73290 commit d110d4b
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 34 deletions.
10 changes: 5 additions & 5 deletions contrib-notes/QA-CHECKLIST-TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@

## Standard Verification

- [ ] Running the pre-req scripts on clean platform images (within a virtualized environment, install from ISO image of Ubuntu. Follow the preqrequistie tool chain as documented on the website.)
- [ ] Running the pre-req scripts on clean platform images (within a virtualized environment, install from ISO image of Ubuntu. Follow the prerequisite tool chain as documented on the website.)
- [ ] Run the QuickStart and follow on tutorials to ensure they are correct [_note currently this means following the instructions on the website, however there is a plan to automate this_]
- [ ] Yo Generator (Angular + CLI) - generates and the code runs succesfully
- [ ] Yo Generator (Angular + CLI) - generates and the code runs successfully
- [ ] Expose as REST API tutorial

*Documentation*
Expand All @@ -36,9 +36,9 @@
### Stable UI
- [ ] Connect to the playground
- [ ] Review model, and submit transaction
- [ ] Update model, redploy, and submit updated transaction on that model
- [ ] Update model, redeploy, and submit updated transaction on that model

<!-- The Engagement teams lab @ https://ibm.ent.box.com/file/141636016965 is a good source of the process and information for the Composuer-UI -->
<!-- The Engagement teams lab @ https://ibm.ent.box.com/file/141636016965 is a good source of the process and information for the Composer-UI -->

### Next UI
- [ ] Running the Car Auction scenario to validate the the new Playground-UI
Expand All @@ -51,4 +51,4 @@
-
-

## General Obervations
## General Observations
2 changes: 1 addition & 1 deletion contrib-notes/coding-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,5 @@ Hyperledger Composer tests use an assertion library called [chai](http://chaijs.

### Code Coverage Using Istanbul

The Hyperledger Composer project uses a code coverage tool called [Istanbul](https://gotwarlost.github.io/istanbul/) to ensure that all the code is tested, including statements, branches and functions. This helps to improve the quality of the Hyperledger Composer tests. The output of Istanbul can be used to see where any specific tests need to be added to ensure complete code coverage.
The Hyperledger Composer project uses a code coverage tool called [Istanbul](https://gotwarlost.github.io/istanbul/) to ensure that all the code is tested, including statements, branches, and functions. This helps to improve the quality of the Hyperledger Composer tests. The output of Istanbul can be used to see where any specific tests need to be added to ensure complete code coverage.

12 changes: 6 additions & 6 deletions contrib-notes/diagnostic-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Hyperledger Composer has a functional logger that can be used for both informational and diagnostic log messages. It also permits customization for different logging 'back-ends'.

## Log points
Log points are added throughout the codebase, and should be very similar to other logging systems. The following APIs match to the standard log levels of *debug, verbose, info, warn, error* Note that *silly* isnt' being used.
Log points are added throughout the codebase, and should be very similar to other logging systems. The following APIs match to the standard log levels of *debug, verbose, info, warn, error* Note that *silly* isn't being used.

```javascript
debug(method, msg, data);
Expand All @@ -12,7 +12,7 @@ warn(method, msg, data);
error(method, msg, data);
```

In addition there are `entry` and `exit` APIs for use to indicate the entry and exit of functions - these are logged at the *debug* level.
In addition, there are `entry` and `exit` APIs for use to indicate the entry and exit of functions - these are logged at the *debug* level.

```javascript
entry(method, data);
Expand Down Expand Up @@ -49,7 +49,7 @@ All the log APIs can take a variable number of data arguments for logging. Any *

## Enabling the logging

In commong with other node.js applications the `DEBUG` environment variable is used. This takes a comma separated list of the modules that need to be logged.
In commong with other node.js applications, the `DEBUG` environment variable is used. This takes a comma separated list of the modules that need to be logged.

Examples

Expand All @@ -60,12 +60,12 @@ Examples
- `DEBUG=composer:client,composer:common` Logs everything from the Hyperledger-Composer common module (the composer-common npm module), and the client module
- `DEBUG=composer:common:businessnetworkdefinition` Logs the businessnetworkdefinition ONLY

## Controling the level and output
## Controlling the level and output

The structure of the Hyperledger-Composer log code is that it delegates the actually logging to a back-end service. This service can swapped by using configuration (see below) but by default uses the Winston library.

### Default configuration
There are two streams setup in the default configuration - one to write log events to a file, the other to the console.
There are two streams setups in the default configuration - one to write log events to a file, the other to the console.

If log is not enabled for Hyperledger-Composer no events are sent to the Console but info events are sent to the file
If the log is enabled then info events are sent to the console and all level of events are sent to the file.
Expand Down Expand Up @@ -104,7 +104,7 @@ $ cat ./config/default.json
}
```
### Modyifing the Winston logger
### Modifying the Winston logger
Here are two examples of how to change the back-end logger simply using Winston's changeable transport feature.

Two cloud hosted application log sites are *Loggly.com* and *Papertrailapp.com*
Expand Down
12 changes: 6 additions & 6 deletions contrib-notes/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@ Please note that this is the **Getting Started** for developing Hyperledger Comp

The requirements for developing Hyperledger Composer are the same as developing an application using Hyperledger Composer. Follow these [instructions](https://hyperledger.github.io/composer/installing/prerequisites.html)

If you wish to install manually or review the indiviual tool's own documentation the details are below.
If you wish to install manually or review the individual tool's own documentation the details are below.

## Tool Chain Reference Details
This is a summary of the tools that will be required to work on Hyperledger Composer. Other tools are required but these will be installed automatically.

- **Git** This is probably already installed on most Linux machines. Setup is well documented on the [ibm.git website](https://help.github.com/enterprise/2.7/user/articles/set-up-git/) . Pay particular attention to[ setting up the SSL keys](https://help.github.com/enterprise/2.7/user/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#platform-linux) that are required.

- **Docker** Essential for the running of the tests and for running the HyperLedger Fabric.
- Ubuntu: Firstly the Docker Engine needs to be [installed](https://docs.docker.com/engine/installation/linux/ubuntulinux/), then the [docker-compose tool](https://docs.docker.com/compose/install/) is required with these instructions. Some initial notes on administering docker are [here](https://docs.docker.com/engine/admin/)
- Ubuntu: Firstly the Docker Engine needs to be [installed](https://docs.docker.com/engine/installation/linux/ubuntulinux/), then the [docker-compose tool](https://docs.docker.com/compose/install/) is required with these instructions. Some initial notes on administering docker are [here](https://docs.docker.com/engine/admin/)

- **Node.js v6** The main runtime of Hyperledger Composer and also has the NPM tool that is used for a lot of the package management.
- Ubuntu: Simply installed [follow these notes](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions).
- Ubuntu: Simply installed [follow these notes](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions).

- **Chrome** Web test suites use **karma** to launch a browser, and consequently **Chrome** must be installed to prevent test failures without editing the karma configuration to use a supported browser that you already have installed.

## Forking and Cloning the Hyperledger Composer Repository

Once those tools are installed you are ready to get going with the Hyperledger Composer repository. Let's show you how to create your own version of the Hyperledger Composer repository in GitHub, and clone it to your local machine to allow you to make your own changes, which you can subsequently contribute to the Hyperledger Composer project.
Once those tools are installed you are ready to get going with the Hyperledger Composer repository. Let's show you how to create your own version of the Hyperledger Composer repository on GitHub, and clone it to your local machine to allow you to make your own changes, which you can subsequently contribute to the Hyperledger Composer project.

- Navigate to the [Hyperledger Project](https://github.com/hyperledger) on GitHub to see the
different Hyperledger Composer repositories.
Expand All @@ -44,7 +44,7 @@ cd ~/github

_IMPORTANT_ Do NOT have any directory in the path to the git repository directory you just created, start with a _ (underscore). This is due to the way that the JavaScript documentation tool handles filtering path names. If you do this, then the tool reports there are no source files to produce documentation for.

Final step is to issue the clone command. This format is assuming that you have setup the ssh keys for GitHub.
The final step is to issue the clone command. This format is assuming that you have setup the ssh keys for GitHub.

```bash
git clone [email protected]:<your-username>/hyperledger/composer.git
Expand All @@ -64,7 +64,7 @@ You can see where the Hyperledger source code is pulled from; it is saved in the

## Installing Hyperledger Composer Prerequisites

Hyperledger Composer has a number of prerequisites - for its runtime, code hygiene, tests, API documentation, and more. Before you can develop locally, you need to install these using [npm](https://www.npmjs.com/). These prerequisites are installed as development dependencies. The packages are installed locally rather than globally, so that their versions do not interfere with other projects you may be developing, or global installations of these packages on your local machine. You can also install these prerequisites globally, though it is required to have some packages locally, e.g. the test framework.
Hyperledger Composer has a number of prerequisites - for its runtime, code hygiene, tests, API documentation, and more. Before you can develop locally, you need to install these using [npm](https://www.npmjs.com/). These prerequisites are installed as development dependencies. The packages are installed locally rather than globally so that their versions do not interfere with other projects you may be developing or global installations of these packages on your local machine. You can also install these prerequisites globally, though it is required to have some packages locally, e.g. the test framework.

### Installing the npm Dependencies

Expand Down
4 changes: 2 additions & 2 deletions contrib-notes/ide-setup.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# IDE setup for Hyperledger Composer development

Both Atom.io and VS Code are popular editors amongts the Hyperledger Composer contributors.
Both Atom.io and VS Code are popular editors amongst the Hyperledger Composer contributors.

# Using Atom

[Atom](https://atom.io/) is the preferred code editor for contributors the Hyperledger Composer project. Many developers find Atom especially productive due to the wide range of plugins availability to assist with code development activities. These include syntax highlighting for node.js code, JavaScript and the Hyperledger Composer modelling language, or *linting* to help eliminate potential bugs and ensure a consistent coding style. Developers can also develop their own plugins. Here's a list of Atom plugins for you consider as you develop within the Hyperledger Composer project.
[Atom](https://atom.io/) is the preferred code editor for contributors the Hyperledger Composer project. Many developers find Atom especially productive due to the wide range of plugins availability to assist with code development activities. These include syntax highlighting for node.js code, JavaScript and the Hyperledger Composer modelling language, or *linting* to help eliminate potential bugs and ensure a consistent coding style. Developers can also develop their own plugins. Here's a list of Atom plugins for you consider as you develop within the Hyperledger Composer project.

## JavaScript and Node.js linting

Expand Down
4 changes: 2 additions & 2 deletions contrib-notes/misc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## JavaScript Parsing using acorn

Hyperledger Composer provides its programming interfaces in JavaScript, and also has the ability to uses JavaScript to express user processing rules which are executed as smart contracts. [acorn](https://www.npmjs.com/package/acorn) is a JavaScript parsing library that significantly assist this process.
Hyperledger Composer provides its programming interfaces in JavaScript, and also has the ability to uses JavaScript to express user processing rules which are executed as smart contracts. [acorn](https://www.npmjs.com/package/acorn) is a JavaScript parsing library that significantly assists this process.

## Checking of files for Hyperledger Composer license agreement using license-check

Hyperledger Composer source files are is provided under a license agreement which provides the appropriate level of intellectual property protection, and [license-check](https://www.npmjs.com/package/license-check) is used to enforce that the same agreement terms is in every Hyperledger Composer file. These license terms may change during the development lifecycle of Hyperledger Composer.
Hyperledger Composer source files are is provided under a license agreement which provides the appropriate level of intellectual property protection, and [license-check](https://www.npmjs.com/package/license-check) is used to enforce that the same agreement terms are in every Hyperledger Composer file. These license terms may change during the development lifecycle of Hyperledger Composer.
4 changes: 2 additions & 2 deletions contrib-notes/raising-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Before you submit an issue, please search to see if your issue has already been
- [GitHub Issues](https://github.com/hyperledger/composer/issues)
- [Rocket Chat history](https://chat.hyperledger.org/channel/fabric-composer)

If you are unable to indentify your issue within the above, then please raise a new issue using the provided [template form](../ISSUE_TEMPLATE.md). Please try to use the template as fully as possible; once completed it will provide us with all the information needed to reproduce, confirm and subsequently fix an identified issue. This is particularly important since certain issues may only manifest themselves on a specific operating system / browser combination.
If you are unable to identify your issue within the above, then please raise a new issue using the provided [template form](../ISSUE_TEMPLATE.md). Please try to use the template as fully as possible; once completed it will provide us with all the information needed to reproduce, confirm and subsequently fix an identified issue. This is particularly important since certain issues may only manifest themselves on a specific operating system / browser combination.

Unfortunately we are not able to investigate / fix bugs that are not documented sufficiently enough to be reproducible. We will contact you if we require more information, but if you do not respond we will close the issue.
Unfortunately, we are not able to investigate / fix bugs that are not documented sufficiently enough to be reproducible. We will contact you if we require more information, but if you do not respond we will close the issue.
20 changes: 10 additions & 10 deletions contrib-notes/weekly-qa-validation.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@

# Validation of the the quality of Hyperledger Composer
# Validation of the quality of Hyperledger Composer

Hyperledger Composer is a open source technology that is developed in the open. Therefore every Pull Request that is merged is a *public* release of code, api and documentation.
Hyperledger Composer is an open source technology that is developed in the open. Therefore every Pull Request that is merged is a *public* release of code, api, and documentation.

First impressions and the overall first experience do count. Even if something isn't perfect for whatever reason, then we can still retain this new relationship _if_ the solution is easily found.

## Aim
To run over a weekly set of testing that ensures we meet a Minimal Standard for Release.

## Objectives
There are prescriptive things to check (see [Standard Verification](#standard-verification) - but a degree of explortory testing is good to find out the edge cases etc.
There are prescriptive things to check (see [Standard Verification](#standard-verification) - but a degree of exploratory testing is good to find out the edge cases etc.

* Is the website instructions still up-to-date?
* Do the pre-reqs still make sense - and can the setup scripts still work?
* Do the tutorials still work?
* Can I get started writing an application without having to make massive leaps?

In addition an objective is to find and close gaps that have been found within the testing.
In addition, an objective is to find and close gaps that have been found within the testing.

## Playbooks

Expand Down Expand Up @@ -57,9 +57,9 @@ $ npm test

```

- [ ] Running the pre-req scripts on clean platform images (within a virtualized environment, install from ISO image of Ubuntu. Follow the preqrequistie tool chain as documented on the website.)
- [ ] Running the pre-req scripts on clean platform images (within a virtualized environment, install from ISO image of Ubuntu. Follow the prerequisite tool chain as documented on the website.)
- [ ] Run the QuickStart and follow on tutorials to ensure they are correct [_note currently this means following the instructions on the website, however there is a plan to automate this_]
- [ ] Yo Generator (Angular + CLI) - generates and the code runs succesfully
- [ ] Yo Generator (Angular + CLI) - generates and the code runs successfully
- [ ] Expose as REST API tutorial

*Documentation*
Expand All @@ -70,7 +70,7 @@ $ npm test

### Playground

Currently there are the two version of the Playground. The developer preview, and the beta for the final version.
Currently, there are two versions of the Playground. The developer preview, and the beta for the final version.

- **Composer-UI** http://fabric-composer-unstable.mybluemix.net/
- **Composer-Playground** http://fabric-composer-next-unstable.mybluemix.net/ _[URL might be changing soon]_
Expand All @@ -86,9 +86,9 @@ The developer preview is still being used for a number of lab workshops, so it s
- [ ] Review model, and submit transaction
- [ ] Update model, redploy, and submit updated transaction on that model

The Engagement teams lab @ https://ibm.ent.box.com/file/141636016965 is a good source of the process and information for the Composuer-UI
The Engagement teams lab @ https://ibm.ent.box.com/file/141636016965 is a good source of the process and information for the Composer-UI

- [ ] Running the Car Auction scenario to validate the the new Playground-UI
- [ ] Running the Car Auction scenario to validate the new Playground-UI

### Exploratory Testing

Expand All @@ -106,7 +106,7 @@ We need to validate on a number of platforms.

- Ubuntu 14:04 & Ubuntu 16:04
- MacOS 10
- _windows 10 is not yet ready_
- _Windows 10 is not yet ready_

### For the playgrounds

Expand Down

0 comments on commit d110d4b

Please sign in to comment.