Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add CONTRIBUTING.md document for newcomers #35

Open
tmcgilchrist opened this issue May 11, 2022 · 0 comments
Open

Add CONTRIBUTING.md document for newcomers #35

tmcgilchrist opened this issue May 11, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tmcgilchrist
Copy link
Contributor

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
@tmcgilchrist tmcgilchrist added documentation Improvements or additions to documentation enhancement New feature or request labels May 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tmcgilchrist