Docs

These are longer-form articles on more persistent topics, compared to the logs which more typically describe events or progressions.

Policies

Primary documents describing our policies:

All documents

tmux Cheatsheet

Drew Leske

tmux is an essential utility for anybody who does a lot of work in terminal windows on Unix systems. It allows you to create multiple virtual terminals, switch between them, detach from them and reattach later and/or from elsewhere, and persists even if your connection to the host system fails or you need to drop it for some reason.

Issue and merge request workflows

Drew Leske

We create issues for all implementation work and generally for analysis work as well. (Other work such as consultations, meetings, e-mails, professional discussions are not tracked, obviously, so it’s important to note that time spent on issues is not expected to add up to the seven-hour workday.) Issues help us track and prioritize work that needs to be done as well as features we may or may not tackle in the future.

Onboarding

Karan Gosal, Bhavy Rai, Paurav Hosur Param and Eduardo Duarte Bassani

Welcome to the ARC Software team! We’re excited to have you on board and looking forward to working with you. It’ll be fun getting to know eachother and work together to accomplish great things.

As you settle in, relax and don’t hesitate to reach out to the team if you have any questions or need assistance. It is always good to ask questions. We are here to support you every step of the way. This is true for junior members, such as co-op students, but also true for those with more experience–our field is always changing, and we’re often on the bleeding edge due to the nature of our work, so we’re all junior in some area from time.

Releases and versioning

Drew Leske

Our policy on releases, release numbering, and versioning is based on semantic versioning and the Python packaging guidelines. For details on how this policy came to be, please visit our blog post on the subject.

Coding norms

Drew Leske

Where the Software Development Guidelines are about the practice of developing software, this document is about details of implementation in all or specific environments.

Software Development Guidelines

Drew Leske

Regardless of language or environment, there are core principles we follow in software development, to encourage readability, maintainability, and joy. Each member of the team is responsible for adhering to these principles and guidelines and to assist and encourage others in doing so.

STRAP User Guide

Paurav Hosur Param

A user guide for ARCsoft’s STRAP deployment application.