Add CONTRIBUTING document #372
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| ### 1. Conventions documentation | ||
|
|
||
| A short paragraph introducing and clarifying the conventions used in the document must be placed (and kept updated) in the top of the document. |
There was a problem hiding this comment.
I don't think we ever agreed on this?
There was a problem hiding this comment.
On this clause, or on the example?
There was a problem hiding this comment.
In general, I think we should remove this point till we decide about this "introductory" paragraph
There was a problem hiding this comment.
Agreed, yeah. It seems to overlap a lot with #194, anyway.
|
|
||
| ### 7. Mentioning models | ||
|
|
||
| We use the console codenames, so: |
There was a problem hiding this comment.
That's fine for designating a single model, but we often need shorthands to designate all color-supporting models. Do we have a convention for those?
There was a problem hiding this comment.
I don't think we have one yet
Co-authored-by: Eldred Habert <eldredhabert0@gmail.com>
Co-authored-by: Eldred Habert <eldredhabert0@gmail.com>
Co-authored-by: Eldred Habert <eldredhabert0@gmail.com>
Co-authored-by: Eldred Habert <eldredhabert0@gmail.com>
Co-authored-by: Eldred Habert <eldredhabert0@gmail.com>
Co-authored-by: Eldred Habert <eldredhabert0@gmail.com>
Co-authored-by: Eldred Habert <eldredhabert0@gmail.com>
|
Alright! Now we just need to:
Awesome! |
Done, I think it's a nice starting point. |
|
Yep. Let's discuss the more uncommon codenames, then? |
I think that can be done in a second moment? The purpose of this PR was to bring what we had in the wiki in a more formalilzed way |
|
Okay. Just needs rebasing and it'll be ready to merge, then. |
On it! |
See #370. Mostly I ported over the stuff that it's currently in the wiki.