Onboarding

Welcome to the Ampersand project!

Below you will find a list of activities to get a new contributor up to speed with Ampersand development.

• To get started, open an issue on GitHub using your own GitHub account, or contact Stef Joosten on GitHub. Describe how you would like to contribute and what access you need.
  • Request access to the GitHub repositories as described below.
• Clone the repositories you need, described below.

GitHub memberships

Ensure you have a GitHub account. This can be a 'professional' account connected to a work email, or any other account. When you request access, mention your GitHub account name (or a link to your profile page).

Request membership to the AmpersandTarski organization.

Github workflow and info

To work on the project you will need a local copy of the repositories you intend to work on. Below is a short description of each repository and what it is used for.

Ampersand

The Ampersand repository contains the Ampersand application that compiles and builds Ampersand applications.

Prototype

The prototype repository gives an Ampersand application a visual interface for users to interact with.

RAP

The RAP repository is an Ampersand application used to create new Ampersand applications. It is used mainly by the Open University of the Netherlands in the course Rule Based Design.

AmpersandTarski.github.io

The AmpersandTarski.github.io repository builds the Docusaurus documentation website. It pulls the docs folders from all the repositories, so make sure to work in the correct docs folder.

For example, a document that is meant for RAP needs to be in the RAP repository's docs folder.

info

Work in the documentation branch while creating or editing documentation, to avoid unnecessary use of the build pipelines.