Skip to content

Commit 55005a9

Browse files
authored
chore(doc): fix outdated "Contributing" section (#199)
1 parent 0b7abb9 commit 55005a9

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

CONTRIBUTING.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# Developer's Certificate of Origin 1.1
1+
# Contributing to Corepack
2+
3+
If you want to build Corepack yourself, you can build the project like this:
4+
5+
1. Clone this repository.
6+
2. Run `yarn install` (or `corepack yarn install` if the global version of
7+
`yarn` is not provided by Corepack).
8+
3. Run `yarn build` (or `corepack yarn build`).
9+
10+
The `dist/` directory now contains the corepack build and the shims.
11+
Call `node ./dist/corepack --help` and behold.
12+
You can also run the tests with `yarn test`.
13+
14+
## Developer's Certificate of Origin 1.1
215

316
By making a contribution to this project, I certify that:
417

README.md

+3-16
Original file line numberDiff line numberDiff line change
@@ -147,25 +147,12 @@ This command will retrieve the given package manager from the specified archive
147147

148148
## Contributing
149149

150-
If you want to build corepack yourself, you can build the project like this:
151-
152-
1. Clone this repository
153-
2. Run `yarn build` (no need for `yarn install`)
154-
3. The `dist/` directory now contains the corepack build and the shims
155-
4. Call `node ./dist/corepack --help` and behold
156-
157-
You can also run the tests with `yarn jest` (still no install needed).
150+
See [`CONTRIBUTING.md`](./CONTRIBUTING.md).
158151

159152
## Design
160153

161-
Various tidbits about Corepack's design are explained in more details in [DESIGN.md](/DESIGN.md).
154+
See [`DESIGN.md`](/DESIGN.md).
162155

163156
## License (MIT)
164157

165-
> **Copyright © Corepack contributors**
166-
>
167-
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
168-
>
169-
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
170-
>
171-
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
158+
See [`LICENSE.md`](./LICENSE.md).

0 commit comments

Comments
 (0)