CONTRIBUTING.md

Contributing

By participating in this project, you agree to abide our code of conduct.

Set up your machine

papercrypt is written in Go.

Prerequisites:

• Task
• Go 1.21+

Other things you might need to run the tests:

• cosign
• Docker
• Syft
• upx
• pdfcpu

On Windows, installed the packages below in WSL.

Relevant System Packages:

• poppler-utils: must be installed for pdftoppm to be available
• upx-ucl: must be installed for upx to be available

Clone papercrypt anywhere:

git clone git@github.com:TMUniversal/papercrypt.git

cd into the directory and install the dependencies:

task setup

A good way of making sure everything is all right is running the test suite:

task test

Test your change

You can create a branch for your changes and try to build from the source as you go:

task build

When you are satisfied with the changes, we suggest you run:

task ci

Before you commit the changes, we also suggest you run:

task fmt

Create a commit

Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits.

You can follow the documentation on their website.

Submit a pull request

Push your branch to your papercrypt fork and open a pull request against the main branch.