question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[CONTRIBUTING] Release and auditing tooling/policy

See original GitHub issue

One reason I sign my commits as much as possible is because I make it a habit so that if someone sees a commit with me as the author without my signature, they can assume I didn’t verify the commit.

If possible, merge my commits without re-committing them (thus removing the signatures) please.

EDIT The below is my summary of the issue based on the rename of the issue to “Set Logic for Merging Pull Requests”


Reasoning

  1. The reason why pull requests exist is to allow for maintainers to review the branch, and merge it.
  2. We can be sure you have merged it only if we A. trust Github or B. you GPG sign a merge (or squash) commit and we can verify your GPG key.
  3. Currently this repo is based on the “trust Github” model, and should be changed.

Proposal

GPG

  1. All maintainers of the repo should create GPG keys and make them public. Upload them to the repo under a folder called “pubkeys” or something just for redundancy, as well as making sure to update them to the keyservers like mit.
  2. All maintainers should verify each other’s Fingerprints in a way where a man in the middle attack is not possible (or highly unlikely) and sign each others keys, uploading the signatures to the keyservers.
  3. If any one maintainer has the chance to get their pubkey signed by a respected member of the community, do so… it will extend their web of trust into the bitcoinjs-lib maintainers.
  4. When possible, all commits and tags should be GPG signed (this requires performing the actions locally, as Github’s web UI does not and should never support GPG signing in the browser.)
  5. When merging a pull request, ensure they follow pull request guidelines, and merge locally using git merge --no-ff -S theiruser/theirbranch and push to the branch they were requesting to. (-S is not needed if you set git config --global commit.gpgsign 1) This is the “merge commit” method… which I think helps keep the chain of responsibility in the git tree itself. Rebasing does not leave a record of who rebased which commits into the tree, and when they did it.

Pull Requests

  1. All pull requests should be cleaned before merging. (ie. five “fix” commits in a row modifying the same value over and over should be squashed into one commit, etc.)
  2. Large commits are fine, but only if they all serve one purpose. If not, they should be split into multiple commits.
  3. Renaming a file and changing that file in the same commit is hard to review, and should be avoided. Rename in one commit, change in another commit.
  4. All merge conflicts should be resolved before merging, and if two pull requests are conflicting, merge one, then ask the author of the other to rebase on master and resolve any merge conflicts.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:18 (18 by maintainers)

github_iconTop GitHub Comments

2reactions
dcousenscommented, Jun 21, 2018

I’m re-opening this as it wasn’t completely satisfied by https://github.com/bitcoinjs/bitcoinjs-lib/pull/1042, and we do want to maybe introduce some tooling or documentation about how to audit/verify the repository against npm or a package management provided bundle.

GPG, SHA256 sums, or otherwise.

1reaction
junderwcommented, Sep 11, 2017

I guess I could rebase locally?

You could try it on the maximumfee PR…

so you would want to be on master, make sure it was up to date with origin, then rebase my branch…

git checkout master
git pull origin master
git add remote junderw git@github.com:junderw/bitcoinjs-lib.git
git fetch junderw
git rebase junderw/fixmaxfees

Then check git log via git log --show-signature to check if my commit signatures are intact…

Read more comments on GitHub >

github_iconTop Results From Across the Web

Section 3. Auditing and Related Professional Practice Standards
A registered public accounting firm and its associated persons shall comply with all applicable auditing and related professional practice standards.
Read more >
Statement on PCAOB Amendments to Strengthen Auditing ...
Today, the Commission approved the Public Company Accounting Oversight Board's (PCAOB) updated standards for audits that involve multiple ...
Read more >
IAASB Welcomes US PCAOB's Efforts to Enhance the ...
The International Auditing and Assurance Standards Board welcomes the release by the US Public Company Accounting Oversight Board (PCAOB) of ...
Read more >
AUDITING STANDARD No. 7 - ENGAGEMENT QUALITY ...
As noted in the reproposing release, such consultations may contribute to audit quality. In addition, one commenter asked the Board to ...
Read more >
The Auditor's Report on an Audit of Financial Statements ...
Breadcrumb. Home · Reports & Testimonies; August 15, 2016, letter commenting on PCAOB's May 2016 Release No. 2016-003 - "Proposed Auditing ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found