Skip to content

Commit

Permalink
chore(doc): fix outdated "Contributing" section (#199)
Browse files Browse the repository at this point in the history
  • Loading branch information
aduh95 authored Oct 24, 2022
1 parent 0b7abb9 commit 55005a9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
# Developer's Certificate of Origin 1.1
# Contributing to Corepack

If you want to build Corepack yourself, you can build the project like this:

1. Clone this repository.
2. Run `yarn install` (or `corepack yarn install` if the global version of
`yarn` is not provided by Corepack).
3. Run `yarn build` (or `corepack yarn build`).

The `dist/` directory now contains the corepack build and the shims.
Call `node ./dist/corepack --help` and behold.
You can also run the tests with `yarn test`.

## Developer's Certificate of Origin 1.1

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

Expand Down
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,25 +147,12 @@ This command will retrieve the given package manager from the specified archive

## Contributing

If you want to build corepack yourself, you can build the project like this:

1. Clone this repository
2. Run `yarn build` (no need for `yarn install`)
3. The `dist/` directory now contains the corepack build and the shims
4. Call `node ./dist/corepack --help` and behold

You can also run the tests with `yarn jest` (still no install needed).
See [`CONTRIBUTING.md`](./CONTRIBUTING.md).

## Design

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

## License (MIT)

> **Copyright © Corepack contributors**
>
> 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:
>
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
>
> 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.
See [`LICENSE.md`](./LICENSE.md).

0 comments on commit 55005a9

Please sign in to comment.