Contributing

Thank you for considering contributing! There are many ways you can help.

Issues

File an issue if you think you've found a bug. Be sure to describe

  1. How can it be reproduced?
  2. What did you expect?
  3. What actually occurred?
  4. Version, platform, etc. if possibly relevant.

You can file all issues with Screwdriver in the screwdriver repo. We will update any issues we're working on with a daily summary. To see what we're currently working on, you can check out our digital scrum board in the Projects section in the Screwdriver API repo.

Docs

Documentation, READMEs, and examples are extremely important. Please help improve them and if you find a typo or notice a problem, feel free to send a fix or say something.

Submitting Patches

Patches for fixes, features, and improvements are accepted through pull requests.

Please ask before embarking on a large improvement so you're not disappointed if it does not align with the goals of the project or owner(s).

Commit Message Format

We use semantic-release, which requires commit messages to be in this specific format: <type>(<scope>): <subject>

Examples commit messages: Bug fix: fix: Remove extra space Breaking change: feat(scm): Support new scm plugin. BREAKING CHANGE: github no longer works

Feature Requests

Make the case for a feature via an issue with a good title. The feature should be discussed and given a target inclusion milestone or closed.

Where to Contribute

Screwdriver has a modular architecture, and the various responsibilities are split up in separate repos.

Screwdriver API Version Open Issues

The screwdriver repo is the core of screwdriver, providing the API endpoints for everything that screwdriver does. The API is based on the hapijs framework and is implemented in node as a series of plugins.

Launcher

The launcher performs step execution and housekeeping internal to build containers. This is written in Go, and mounted into build containers as a binary.

Executors

An executor is used to manage build containers for any given job. Several implementations of executors have been created. All are designed to follow a common interface. Executor implementations are written in node:

Models

The object models provide the definition of the data that is stored in data stores. This is done in two parts:

Datastores

A datastore implementation is used as the interface between the API and a data storage mechanism. There are several implementations written in node around a common interface.

Scms

An scm implementation is used as the interface between the API and an scm. There are several implementations written in node around a common interface.

Config Parser Version

Node module for validating and parsing user's screwdriver.yaml configurations.

Guide

This documentation! Everything you ever hoped to know about the Screwdriver project.

Miscellaneous Tools

Adding a New Screwdriver Repo

We have some tools to help start out new repos for screwdriver: