github.com/StackExchange/blackbox/v2@v2.0.1-0.20220331193400-d84e904973ab/docs/dev.md (about)

     1  Developer Info
     2  ==============
     3  
     4  Code submissions are gladly welcomed! The code is fairly easy to read.
     5  
     6  Get the code:
     7  
     8  ```
     9  git clone git@github.com:StackExchange/blackbox.git
    10  ```
    11  
    12  Test your changes:
    13  
    14  ```
    15  go test ./...
    16  ```
    17  
    18  This runs through a number of system tests. It creates a repo,
    19  encrypts files, decrypts files, and so on. You can run these tests to
    20  verify that the changes you made didn't break anything. You can also
    21  use these tests to verify that the system works with a new operating
    22  system.
    23  
    24  Please submit tests with code changes:
    25  
    26  The best way to change BlackBox is via Test Driven Development. First
    27  add a test to `tools/confidence.sh`. This test should fail, and
    28  demonstrate the need for the change you are about to make. Then fix
    29  the bug or add the feature you want. When you are done, `make
    30  confidence` should pass all tests. The PR you submit should include
    31  your code as well as the new test. This way the confidence tests
    32  accumulate as the system grows as we know future changes don't break
    33  old features.
    34  
    35  Note: More info about compatibility are on the [Compatibility Page](compatibility.md)
    36