/arcadia-software-handbook

Core software engineering guides and policies at Arcadia Science

Primary LanguageMakefileCreative Commons Zero v1.0 UniversalCC0-1.0

Arcadia Science Software Handbook

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 standard document is a good place to start!

Naming conventions

  • A guide document describes software engineering best practices for reusable and reproducible work. These are sensible defaults and exceptions to the rule are expected to happen.
  • A standard document describes a company operating standard that all Arcadians are expected to comply with.

Contributing

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.

License

This repository is dedicated to the public domain. See the LICENSE file for more details.