Skip to content

Commit

Permalink
add acknowledgement section
Browse files Browse the repository at this point in the history
  • Loading branch information
nilslice committed May 10, 2018
1 parent 88e33fc commit 0aec54e
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,36 @@ Track your `.proto` files and prevent incompatible changes to field names and nu

## Why

Ever _accidentally_ break your API compatibility while you're busy fixing problems? You may have forgotten to reserve the field number of a message or re-order fields after removing a property. A new team member may not be familiar with the backward-compatibility of Protocol Buffers and make an easy mistake.
Ever _accidentally_ break your API compatibility while you're busy fixing problems? You may have forgotten to reserve the field number of a message or you re-ordered fields after removing a property. Maybe a new team member was not familiar with the backward-compatibility of Protocol Buffers and made an easy mistake.

`protolock` attempts to help prevent this from happening.

## Usage

Similar in concept to the higher-level features of `git`, track and/or prevent changes to your `.proto` files.

1. Initialize your repository:
1. **Initialize** your repository:

$ protolock init

3. Add changes to protobuf messages or services:
3. **Add changes** to protobuf messages or services:

$ protolock commit

2. Check that no breaking changes were made:
2. **Check** that no breaking changes were made:

$ protolock status

4. Integrate into your protobuf compilation step:
4. **Integrate** into your protobuf compilation step:

$ protolock status && protoc --I ...

In all, prevent yourself from compiling your protobufs and generating code if breaking changes have been made.

---
**Recommended:** commit the output `proto.lock` file into your version control system

---

## Acknowledgement

Thank you to Ernest Micklei for his work on the excellent parser heavily relied upon by this tool and many more: [https://github.com/emicklei/proto](https://github.com/emicklei/proto)

0 comments on commit 0aec54e

Please sign in to comment.