This repository is home to the core software engineering guides and standards at Arcadia Science. If you're curious about where to begin, the source control standards document is a good place to start!
- A guide describes software engineering best practices for reusable and reproducible work. These are sensible defaults and exceptions to the rule are expected to happen.
- A standards document describes a company-wide operating standard that all Arcadians are expected to comply with.
-
Standard for source control: This standard defines how to use git and GitHub at Arcadia. This includes naming conventions, repository settings, and how to work with branches and PRs.
-
Standard for public GitHub repositories: This standard lists the requirements with which all public GitHub repositories must comply.
-
Code review guidelines: This guide explains conventions and best practices for participating in code reviews at Arcadia.
-
Guide for choosing software dependencies: This guide includes considerations and tips for choosing software dependencies when writing workflows or tools that we expect to be used by others many times.
To propose a change, submit a pull request. Consider the following goals of the onboarding document:
- Simple: Use straightforward language and avoid jargon.
- Concise: The document should be readable in a single sitting.
- Specific: It should be targeted to Arcadia Science scientists and software engineers.
- Enforceable: Failure to meet expectations should have consequences.
- Living: The document is expected to change.
This repository is dedicated to the public domain. See the LICENSE file for more details.