Skip to content

Commit

Permalink
update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
paulcpederson committed Jun 12, 2015
1 parent 448cf80 commit db7f932
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 40 deletions.
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Contributing to Calcite Web
# Contributing

Installing Calcite Web was designed to be fairly painless. If you have any problems, be sure to [submit an issue](https://github.com/Esri/calcite-web/issues/).
Calcite Web is open to all types of contributions from across Esri. Things you can do to contribute include:

1. Report a bug ([open an issue](https://github.com/Esri/calcite-web/issues/new))
2. Suggest a new pattern or component ([open an issue](https://github.com/Esri/calcite-web/issues/new))
3. Fork the repository and fix one of the [open issues](https://github.com/Esri/calcite-web/issues)
4. Report problems with the [documentation](http://esri.github.io/calcite-web/).

### Install Dependencies

Calcite Web has three main dependencies. If you already have these on your computer, you can skip these steps:
Calcite Web has two development dependencies, Node.js and Grunt. If you already have these on your computer, you can skip these steps:

1. Visit [nodejs.org](http://nodejs.org/) to install Node.
2. `npm install -g grunt-cli` to install Grunt.
3. `gem install sass` to install SASS.

### Fork the Repository

Expand Down Expand Up @@ -60,7 +64,7 @@ The final number signifies patches such as fixing a pattern or component in a ce
1. Change the version number in `package.json` to the desired version number.
2. Write a description of the changes, additions, and bug fixes in `CHANGELOG.md`.
3. Make sure `Esri/calcite-web` is up-to-date with your changes.
5. Run `grunt release` and enter your username and password in the command prompt.
5. Run `grunt release`. If prompted enter your GitHub credentials and your s3 access key/secret.

# Updating the Documentation Site

Expand Down
28 changes: 28 additions & 0 deletions docs/source/get-started/_contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Calcite Web is open to all types of contributions from across Esri. Things you can do to contribute include:

1. Report a bug ([open an issue](https://github.com/Esri/calcite-web/issues/new))
2. Suggest a new pattern or component ([open an issue](https://github.com/Esri/calcite-web/issues/new))
3. Fork the repository and fix one of the [open issues](https://github.com/Esri/calcite-web/issues)
4. Report problems with the [documentation](http://esri.github.io/calcite-web/).

### Install Dependencies

Calcite Web has two development dependencies, Node.js and Grunt. If you already have these on your computer, you can skip these steps:

1. Visit [nodejs.org](http://nodejs.org/) to install Node.
2. `npm install -g grunt-cli` to install Grunt.

### Fork the Repository

All the code for Calcite Web lives [on GitHub](https://github.com/esri/calcite-web). We use the [fork and pull model](https://help.github.com/articles/using-pull-requests/) to manage contribution.

1. Fork the repository so you have your own copy (`your-username/calcite-web`)
2. Clone the repo locally with `git clone https://github.com/your-username/calcite-web`
3. Move into the clone repo: `cd calcite-web`
4. Install project dependencies: `npm install`

You should also add `Esri/calcite-web` as a remote at this point. We generally call this remote branch 'upstream':

```
git remote add upstream https://github.com/Esri/calcite-web
```
2 changes: 1 addition & 1 deletion docs/source/get-started/_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ To run a development environment, just type `grunt`. You should have a copy of t

### How We Use GitHub

All the code for Calcite Web lives on [GitHub](https://github.com/esri/calcite-web). We use the [fork and pull model](https://help.github.com/articles/using-pull-requests/) to manage contribution. To contribute, you should:
All the code for Calcite Web lives [on GitHub](https://github.com/esri/calcite-web). We use the [fork and pull model](https://help.github.com/articles/using-pull-requests/) to manage contribution. To contribute, you should:

1. Commit your changes.
2. Note your changes in `CHANGELOG.md`
Expand Down
26 changes: 0 additions & 26 deletions docs/source/get-started/_install.md

This file was deleted.

18 changes: 12 additions & 6 deletions docs/source/get-started/_versioning.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
Calcite Web uses SemVer (Semantic Versioning) for its releases. This means that version numbers are basically formatted like `MAJOR.MINOR.PATCH`. If you're well acquainted with SemVer you should skip to [releasing a new version](#releasing-a-new-version) below.
Calcite-Web uses SemVer (Semantic Versioning) for its releases. This means that version numbers are basically formatted like `MAJOR.MINOR.PATCH`. If you're well acquainted with SemVer you should skip to 'Bumping the Version' below.

#### Major

Breaking changes are signified with a new **first** number. For example, moving from `1.0.0` to `2.0.0` implies breaking changes.
Breaking changes are signified with a new **first** number. For example, moving from 1.0.0 to 2.0.0 implies breaking changes.

#### Minor

New components, new helper classes, or substantial visual changes to existing components and patterns are *minor releases*. These are signified by the second number changing. So from `1.1.2` to `1.2.0` there are minor changes.
New components, new helper classes, or substantial visual changes to existing components and patterns are *minor releases*. These are signified by the second number changing. So from 1.1.2 to 1.2.0 there are minor changes.

#### Patches

The final number signifies patches such as fixing a pattern or component in a certain browser, or fixing an existing bug. Small changes to the documentation site and the tooling around the Calcite Web library are also considered patches.
The final number signifies patches such as fixing a pattern or component in a certain browser, or fixing an existing bug. Small changes to the documentation site and the tooling around the Calcite-Web library are also considered patches.

## Releasing a New Version
## Bumping the Version

1. Change the version number in `package.json` to the desired version number.
2. Write a description of the changes, additions, and bug fixes in `CHANGELOG.md`.
3. Make sure `Esri/calcite-web` is up-to-date with your changes.
4. Run `grunt release` and enter your GitHub username and password.
5. Run `grunt release`. If prompted enter your GitHub credentials and your s3 access key/secret.

# Updating the Documentation Site

To update the documentation site, just make sure you have push access to the `Esri/calcite-web` repo and type `grunt deploy`. This will build the site and deploy to gh-pages.

The site should be updated at http://esri.github.io/calcite-web/ in just a few moments.
4 changes: 2 additions & 2 deletions docs/source/table_of_contents.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ get-started:
link: npm
- group: 'Contributing'
pages:
- title: 'Install'
- title: 'Overview'
id: '53a4132e-ce9f-4e10-bf10-366778372167'
link: install
link: contributing
- title: 'Development'
id: '99ea74b8-7a26-4dd2-8944-e82dcb1d39cb'
link: development
Expand Down

0 comments on commit db7f932

Please sign in to comment.