Skip to content

Create a CONTRIBUTING.md #77

Description

@ConnorNelson

We want to specify the workflows for:

  • Becoming a maintainer (PR against mantainers.yml)
  • The process for decrypting encrypted data as a maintainer
  • Creating a new module
    • git crypt init -k $MODULE
    • echo "**/tests_private/** filter=git-crypt-$MODULE diff=git-crypt-$MODULE" > ./challenges/$MODULE/.gitattributes
    • sed -n '/BEGIN PGP PUBLIC KEY BLOCK/,/END PGP PUBLIC KEY BLOCK/{p;/END PGP PUBLIC KEY BLOCK/q;}' ./maintainers.yml | gpg --import
    • git crypt add-gpg-user --key-name "$MODULE" root@pwn.college
    • Additionally, maintainers.yml may need to be updated to make sure access continues to be allowed (otherwise you might create a new module, for which you aren't a maintainer, which sounds bad)

This all is untested, and probably should be wrapped by a cleaner interface. Probably one (or more) tools in ./tools/maintainers.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions