Skip to content

Commit

Permalink
Docs for Commit Signing (#6)
Browse files Browse the repository at this point in the history
* Create commit-signing.md

* Update README.md
  • Loading branch information
gksander authored Apr 13, 2022
1 parent 923f86d commit de66508
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This repository houses the source code for the Coinbase Pay Javascript SDK. This SDK allows third-party partners to integrate with the Coinbase Pay service.

## Contributing

See [the Contributing doc](./CONTRIBUTING.md) for more information on contributing. Commit signing is required for contributing to this repo – see [this document on commit-signing](./docs/commit-signing.md) for information on getting setup with commit signing.

## Basic Usage

Start by installing the SDK from NPM (NOTE: this is not yet public, so this call will fail):
Expand Down
44 changes: 44 additions & 0 deletions docs/commit-signing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Commit Signing

This comment has been minimized.

Copy link
@Originalmenace

Originalmenace Dec 19, 2022

This comment has been minimized.

Copy link
@Aroc902322

This comment has been minimized.

This comment has been minimized.

Copy link
@Muhammadamjadm

Muhammadamjadm Feb 8, 2024

It's ok

This comment has been minimized.

Copy link
@Muhammadamjadm

Muhammadamjadm Feb 8, 2024

[de

This comment has been minimized.


This repository requires commit signing. This document outlines how to get commit signing setup for this repo.

This comment has been minimized.

Copy link
@Emah80

Emah80 Mar 19, 2023

Generate

## Generate a GPG key

If you're on a Mac, you can install the `gpg` CLI via homebrew with

```shell
brew install gpg
```

Then you can use the `gpg` tool to generate a keypair:

```shell
gpg --default-new-key-algo rsa4096 --quick-generate-key --batch --passphrase "" "Firstname Lastname <[email protected]>"

This comment has been minimized.

Copy link
@Aroc902322

Aroc902322 Dec 20, 2023

"Aaron Harper" [email protected]

```

Replace `[email protected]` with your actual email. **Leave the angle brackets though!**

## Upload your public key to GitHub

This comment has been minimized.

Copy link
@Muhammadamjadm

Muhammadamjadm Feb 20, 2024

Aaa


From your GitHub settings (SSH & GPG Keys), you'll need to upload your recently-generated GPG public key. You can use the following command to grab that key:

```shell
gpg --armor --export [email protected] | pbcopy

This comment has been minimized.

Copy link
@Originalmenace

This comment has been minimized.

Copy link
@Originalmenace
```

This should copy your public key to your clipboard, and you can paste this into your GitHub settings page (for adding a new GPG key).

## Enabling git signing for this repo

This comment has been minimized.

Copy link
@Originalmenace

Originalmenace Dec 19, 2022

Enabling git signing for this repo


Now, let's set a few git options **local for this repo**. Make sure you're `cd`'d into this repo and then run the following.

```shell
# Use your public GitHub credentials
git config user.name "Firstname Lastname"

This comment has been minimized.

Copy link
@Originalmenace

Originalmenace Dec 19, 2022

jesse minton

This comment has been minimized.

Copy link
@Aroc902322

Aroc902322 Dec 20, 2023

Aaron Harper ``

This comment has been minimized.

Copy link
@Muhammadamjadm

Muhammadamjadm Feb 8, 2024

Nnnn

This comment has been minimized.

Copy link
@Muhammadamjadm

Muhammadamjadm Feb 8, 2024

Nnnn

git config user.email "[email protected]"

This comment has been minimized.

Copy link
@Aroc902322
# Set up commit signing
git config user.signingkey [email protected]
git config user.gpgsign true
```

Notice the *lack* of `--global` flag in those commands. This will set these git credentials/configuration for just this repository.

2 comments on commit de66508

@Mortiemi
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

``

@Chief1934
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EIP-170 issue and discussion: ethereum/EIPs#170
pyethereum implementation: https://github.com/ethereum/pyethereum/blob/5217294871283d8dc4fb3ca9d8a78c7d416490e8/ethereum/messages.py#L397
Citation
Please cite this document as:

Vitalik Buterin (@vbuterin), "EIP-170: Contract 880105https://github.com/ethereum/EIPs/issues/170EIP-170 issue and discussion: ethereum/EIPs#170
pyethereum implementation: https://github.com/ethereum/pyethereum/blob/5217294871283d8dc4fb3ca9d8a78c7d416490e8/ethereum/messages.py#L397
Citation
Please cite this document as:

Vitalik Buterin (@vbuterin), "EIP-170: Contract

Please sign in to comment.