Skip to content

Commit 07aa91f

Browse files
committed
docs: consolidate contributing in readme
1 parent 4ed35b4 commit 07aa91f

File tree

1 file changed

+26
-21
lines changed

1 file changed

+26
-21
lines changed

Readme.md

+26-21
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44

55
[![NPM Version][npm-version-image]][npm-url]
66
[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
7-
[![Linux Build][github-actions-ci-image]][github-actions-ci-url]
8-
[![Windows Build][appveyor-image]][appveyor-url]
9-
[![Test Coverage][coveralls-image]][coveralls-url]
107

118
```js
129
const express = require('express')
@@ -33,7 +30,7 @@ the [`npm init` command](https://docs.npmjs.com/creating-a-package-json-file).
3330
Installation is done using the
3431
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
3532

36-
```bash
33+
```console
3734
$ npm install express
3835
```
3936

@@ -61,35 +58,31 @@ for more information.
6158

6259
**PROTIP** Be sure to read [Migrating from 3.x to 4.x](https://github.com/expressjs/express/wiki/Migrating-from-3.x-to-4.x) as well as [New features in 4.x](https://github.com/expressjs/express/wiki/New-features-in-4.x).
6360

64-
### Security Issues
65-
66-
If you discover a security vulnerability in Express, please see [Security Policies and Procedures](Security.md).
67-
6861
## Quick Start
6962

7063
The quickest way to get started with express is to utilize the executable [`express(1)`](https://github.com/expressjs/generator) to generate an application as shown below:
7164

7265
Install the executable. The executable's major version will match Express's:
7366

74-
```bash
67+
```console
7568
$ npm install -g express-generator@4
7669
```
7770

7871
Create the app:
7972

80-
```bash
73+
```console
8174
$ express /tmp/foo && cd /tmp/foo
8275
```
8376

8477
Install dependencies:
8578

86-
```bash
79+
```console
8780
$ npm install
8881
```
8982

9083
Start the server:
9184

92-
```bash
85+
```console
9386
$ npm start
9487
```
9588

@@ -109,31 +102,43 @@ $ npm start
109102

110103
To view the examples, clone the Express repo and install the dependencies:
111104

112-
```bash
105+
```console
113106
$ git clone git://github.com/expressjs/express.git --depth 1
114107
$ cd express
115108
$ npm install
116109
```
117110

118111
Then run whichever example you want:
119112

120-
```bash
113+
```console
121114
$ node examples/content-negotiation
122115
```
123116

124-
## Tests
117+
## Contributing
118+
119+
[![Linux Build][github-actions-ci-image]][github-actions-ci-url]
120+
[![Windows Build][appveyor-image]][appveyor-url]
121+
[![Test Coverage][coveralls-image]][coveralls-url]
122+
123+
The Express.js project welcomes all constructive contributions. Contributions take many forms,
124+
from code for bug fixes and enhancements, to additions and fixes to documentation, additional
125+
tests, triaging incoming pull requests and issues, and more!
126+
127+
See the [Contributing Guide](Contributing.md) for more technical details on contributing.
125128

126-
To run the test suite, first install the dependencies, then run `npm test`:
129+
### Security Issues
130+
131+
If you discover a security vulnerability in Express, please see [Security Policies and Procedures](Security.md).
127132

128-
```bash
133+
### Running Tests
134+
135+
To run the test suite, first install the dependencies, then run `npm test`:
136+
137+
```console
129138
$ npm install
130139
$ npm test
131140
```
132141

133-
## Contributing
134-
135-
[Contributing Guide](Contributing.md)
136-
137142
## People
138143

139144
The original author of Express is [TJ Holowaychuk](https://github.com/tj)

0 commit comments

Comments
 (0)