tarides / tezos-ci

OCurrent CI for Tezos
https://tezos.ci.dev
3 stars 7 forks source link

Add CONTRIBUTING.md document for newcomers #35

Open tmcgilchrist opened 2 years ago

tmcgilchrist commented 2 years ago

Background

We strongly believe it should be possible to checkout tezos-ci, get the project building and running by reading a document inside this repository. There should be a well documented and tested set of steps for onboarding, that works on Linux and OSX.

Summary

Provide a CONTRIBUTING.md document and suitable steps in the main README.md documenting how to start running and developing tezos-ci. For reference a similar document exists in opam-repo-ci

Outcome

A documented and tested markdown document is provided within the repository for getting started with contributing to tezos-ci. This document should be validated by at least 2 people outside the team developing tezos-ci