documentation
documentation copied to clipboard
Add `CONTRIBUTING`
Context
The docs project seems to be missing a CONTRIBUTING.md
doc that would outline the expectations for both internal and external contributors to the docs. See Sensu's CONTRIBUTING doc for an example. Some other notes about what to include in our version:
- How to build/test the docs locally (Moving what we currently have in the README)
- Branch/naming conventions
- Do we prefer fork/branch or just branch off of the prod branch to add new content
- Any stylistic elements that are critical for community contributions
@bernd @asachs01 Can I help you guys? I can move over the necessary stuff from the README.md
Howdy @devaslooper ! I'm soooooo behind on my github notifications 😓 . If you want to, I'm totally down for it.
- How to build/test the docs locally (Moving what we currently have in the README)
- Branch/naming conventions
- Do we prefer fork/branch or just branch off of the prod branch to add new content
- Any stylistic elements that are critical for community contributions
Hey, @asachs01 !!! I would like to work on this issue. But can you tell me from where I would get the above quoted info?
Ok, I figured out about
- How to build/test the docs locally (Moving what we currently have in the README)
For this issue > *Do we prefer fork/branch or just branch off of the prod branch to add new content) what I can guess is that we should use fork/branch. For the rest two I have need your help @asachs01