Giter Site home page Giter Site logo

ahunt / gitgitgadget Goto Github PK

View Code? Open in Web Editor NEW

This project forked from gitgitgadget/gitgitgadget

1.0 0.0 0.0 3.38 MB

Sending GitHub PRs to the Git mailing list

Home Page: https://gitgitgadget.github.io/

License: ISC License

JavaScript 5.77% TypeScript 85.23% Shell 9.00%

gitgitgadget's Introduction

Contributing git.git patches via GitHub PRs

This project's goal is to make contributions to the Git project (almost) as easy as opening a GitHub PR. The idea is for users to open a Pull Request at

https://github.com/gitgitgadget/git

with a good description of their patch series. Then, the command /submit, issued via a comment on said PR will tell GitGitGadget to send the patches as mail thread to the Git mailing list, with the Pull Request's description as cover letter.

As is common, reviewers on the Git mailing list will probably ask for modifications. These should be folded into the respective commits (or inserted as stand-alone commits at an appropriate place in the patch series) via git rebase -i, followed by a force-push. Once everything is in a good shape, update the description to include information about changes performed relative to the latest patch series iteration, and then another /submit will ask GitGitGadget to send a new iteration of the patch series.

All relevant information, such as the current iteration of the patch series, the Message-ID of the sent mails, etc is stored in the Git notes in refs/notes/gitgitgadget.

Note: GitGitGadget will Cc: the original authors when sending patches on their behalf, and people mentioned in the Cc: footer of the Pull Request description.

Furthermore, for all iterations of a patch series but the first one, GitGitGadget will insert a machine-generated representation of what changed, and reply to the cover letter of the previous iteration.

For convenience of reviewers, GitGitGadget will generate tags for each iteration it sent, and push those to https://github.com/gitgitgadget/git. Links to those tags will be included in the cover letter.

gitgitgadget's People

Contributors

azure-pipelines[bot] avatar benpeart avatar dependabot[bot] avatar derrickstolee avatar dscho avatar gitster avatar logiclrd avatar nasamuffin avatar phil-blain avatar syntevoalex avatar ugultopu avatar utsav2 avatar webstech avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.