Formatting fixes

This commit is contained in:
John Mulhausen 2016-10-25 11:46:58 -07:00 committed by GitHub
parent ca6cc535bf
commit 50ae057a97
1 changed files with 69 additions and 37 deletions

View File

@ -24,6 +24,7 @@ Kitematic is built on top of:
To get started, you will need to install Node.js v4.2.1. Using Node Version Manager (NVM) makes the Node.js install easy. To get started, you will need to install Node.js v4.2.1. Using Node Version Manager (NVM) makes the Node.js install easy.
### Windows: ### Windows:
1. Download <a href="https://github.com/coreybutler/nvm-windows/releases/" 1. Download <a href="https://github.com/coreybutler/nvm-windows/releases/"
target="_blank"> latest release </a> target="_blank"> latest release </a>
@ -39,7 +40,9 @@ the above installer link will have an uninstaller available.
2. Copy and paste the following install script: 2. Copy and paste the following install script:
```
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.29.0/install.sh | bash curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.29.0/install.sh | bash
```
3. To activate nvm, close the terminal window and re-open a new one. 3. To activate nvm, close the terminal window and re-open a new one.
@ -51,15 +54,21 @@ the above installer link will have an uninstaller available.
1. Install the proper Node.js version. 1. Install the proper Node.js version.
```
$ nvm install v4.2.1 $ nvm install v4.2.1
```
2. Make this version the default. 2. Make this version the default.
```
$ nvm alias default v4.2.1 $ nvm alias default v4.2.1
```
3. Run `node --version` to confirm that you are now using the proper Node.js version. 3. Run `node --version` to confirm that you are now using the proper Node.js version.
```
$ node --version $ node --version
```
## Fork the master branch of Kitematic ## Fork the master branch of Kitematic
@ -83,7 +92,9 @@ To clone your repository and create a branch for the issue:
1. Open a terminal window on your local host and change to your home directory. 1. Open a terminal window on your local host and change to your home directory.
```
$ cd ~ $ cd ~
```
In Windows, you'll work in your Docker Quickstart Terminal window instead of Powershell or a `cmd` window. In Windows, you'll work in your Docker Quickstart Terminal window instead of Powershell or a `cmd` window.
@ -91,33 +102,45 @@ To clone your repository and create a branch for the issue:
3. From the root of your repository, clone the fork to your local host. 3. From the root of your repository, clone the fork to your local host.
```
$ git clone https://github.com/YOUR_USERNAME/kitematic.git $ git clone https://github.com/YOUR_USERNAME/kitematic.git
```
4. Create and checkout a branch for the issue you will be working on. 4. Create and checkout a branch for the issue you will be working on.
```
$ git checkout -b 1191-branch $ git checkout -b 1191-branch
```
As previously mentioned, issue <a href="https://github.com/docker/kitematic/issues/1191" target="_blank">#1191</a> is set up as an example to use for this exercise. As previously mentioned, issue <a href="https://github.com/docker/kitematic/issues/1191" target="_blank">#1191</a> is set up as an example to use for this exercise.
## Set up your signature and upstream remote ## Set up your signature and upstream remote
You can set your signature globally or locally. You can set your signature globally or locally.
1. Set your `user.name` for the repository. 1. Set your `user.name` for the repository.
```
$ git config --local user.name "FirstName LastName" $ git config --local user.name "FirstName LastName"
```
2. Set your `user.email` for the repository. 2. Set your `user.email` for the repository.
```
$ git config --local user.email "emailname@mycompany.com" $ git config --local user.email "emailname@mycompany.com"
```
3. Check the result in your `git` configuration. 3. Check the result in your `git` configuration.
```
$ git config --local --list $ git config --local --list
```
4. Set your local repository to track changes upstream, on the `kitematic` 4. Set your local repository to track changes upstream, on the `kitematic` repository.
repository.
```
$ git remote add upstream https://github.com/docker/kitematic.git $ git remote add upstream https://github.com/docker/kitematic.git
```
(To learn more, see <a (To learn more, see <a
href="http://docs.docker.com/opensource/project/set-up-git/#set-your-signature-and-an-upstream-remote" target="_blank"> Set up your signature and an upstream remote</a>.) href="http://docs.docker.com/opensource/project/set-up-git/#set-your-signature-and-an-upstream-remote" target="_blank"> Set up your signature and an upstream remote</a>.)
@ -127,18 +150,25 @@ Your Node.js install includes npm for package management. You'll use it to insta
1. Verify that the package manager is running and check the version (at the time of this writing, v2.14.7). 1. Verify that the package manager is running and check the version (at the time of this writing, v2.14.7).
```
$ npm --version $ npm --version
```
2. Install the package dependencies. 2. Install the package dependencies.
```
$ npm install $ npm install
```
3. From the root of your kitematic repository, use the package manager to start Kitematic and confirm everything went well. 3. From the root of your kitematic repository, use the package manager to start Kitematic and confirm everything went well.
```
$ npm start $ npm start
```
All of the core files in Kitematic are in the `src` folder, which then All of the core files in Kitematic are in the `src` folder, which then
follows the AltJS structure of: follows the AltJS structure of:
``` ```
kitematic/ kitematic/
|--src/ |--src/
@ -149,8 +179,10 @@ kitematic/
|--components/ |--components/
| |--MyComponent.react.js | |--MyComponent.react.js
``` ```
The `components` folder is where the layout files are, the `stores` represent the application logic and `actions` are the dispatcher for actions taken within the `components`. The `components` folder is where the layout files are, the `stores` represent the application logic and `actions` are the dispatcher for actions taken within the `components`.
## Where to go next ## Where to go next
You are ready to start working on the issue. Go to [Develop in Kitematic (work You are ready to start working on the issue. Go to [Develop in Kitematic (work
on an issue)](work_issue.md). on an issue)](work_issue.md).