gctoolkit icon indicating copy to clipboard operation
gctoolkit copied to clipboard

Linked Developers Guide to Contributing doc

Open karianna opened this issue 3 years ago • 4 comments

the CONTRIBUTING.md and DEVELOPERS_GUIDE.md need to cross reference.

karianna avatar Jan 05 '22 10:01 karianna

? specifics ?

ghost avatar Jan 05 '22 22:01 ghost

One file should acknowledge the existence of the other.

In other words, we should consider start writing proper Docs :-D

brunoborges avatar Jan 06 '22 01:01 brunoborges

I'm not sure what is meant by "proper" docs but I do know that improvements to the documentation are a high priority and are in-flight. If you have specific suggestions please do post them.

kcpeppe avatar Jan 06 '22 06:01 kcpeppe

? specifics ?

Most developers who work on GitHub projects will look to the CONTRIBUTING.md file for help on contributing (there's automatic tooling around this as well), without a link in that doc to your new DEVELOPERS_GUIDE.md file, folks are going to miss it :-).

karianna avatar Jan 06 '22 12:01 karianna