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.

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

Add a full guide detailing the common structure, technical standards, style conventions, and writing guidelines #37

Closed
CAM-Gerlach opened this issue May 13, 2018 · 0 comments
Assignees
Milestone

Comments

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented May 13, 2018

Issue Description

Currently, we have only a very minimal set of standards, conventions and guidelines in our contributing guide; this proposes adding, likely as a separate document with a few elements from contributing merged in, a comprehensive outline of the common document and file structure, the technical standards to be adhered to, and the style conventions to follow for rst and prose, and guidelines to writing accessable technical documentation. I've written up a copy locally, but it is still in draft form and may still change before #13 is completed, and also needs some polish and clarification for public release. Therefore, I plan to do this as one of the first tasks after the initial public release.

Also, as part of this should update PR (and Issue?) templates with "check style guide", and should also add how to create a fork, branch, and submit PR to the contributing guide, and any other build instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant