CONTRIBUTING.md file - Githubissues

teambit / envs

Component development environments for the Bit community

https://bit.dev/bit/envs

Other

64 stars 9 forks source link

CONTRIBUTING.md file #39

Closed imsnif closed 4 years ago

imsnif commented 4 years ago

It would be great if we could have a basic CONTRIBUTING.md file that tells us how to use this repo.

It should include all the steps from cloning the repo up to using a built compiler/tester in a different project with bit.

qballer commented 4 years ago

Can you provide specific bullets on what you would like to see there.

options/file explained
build /test cycle
project structure

imsnif commented 4 years ago

how to build a compiler/tester
how to use it in your project

The best would be simple 2-3 steps of copy-pastable instructions. No explanations necessary - just something that would work and we wouldn't have to think about.