CONTRIBUTING.md

Contributing to AIA

Hi there! 👋 We're thrilled that you'd like to contribute to AIA.

Contents

• Contributing to AIA
  • Contents
  • Directory structure
  • Development setup
    • Requirements
      • Node.js
      • Python
    • Actual AIA setup
    • Start
  • Development cycle
    • Test suite
  • Create new algorithms
  • Report a bug
  • Propose a change

Directory structure

AIA is purely frontend code written in React.

The most important directories:

• /src/algorithms - Where the algorithms are implemented
• /src/components - Where the React components are implemented
• /src/pseudocode - How the pseudocodes are parsed

Development setup

Requirements

Node.js

Node.js version 18.17.1 or newer is required for development purposes.

Python

Python version 3.9.6 or newer is required for development purposes.

Actual AIA setup

IMPORTANT: All the steps below have to get executed at least once to get the development setup up and running!

Now that everything AIA requires to run is installed, the actual AIA code can be checked out and set up:

1. Fork the AIA repository.

2. Clone your forked repository:

   git clone https://github.com/<your_github_username>/algorithms-in-action.github.io.git

3. Go into repository folder:

   cd algorithms-in-action.github.io

4. Add the original AIA repository as upstream to your forked repository:

   git remote add upstream https://github.com/algorithms-in-action/algorithms-in-action.github.io.git

5. Install all dependencies:

   npm install

Start

To start AIA execute:

npm start

Development cycle

While iterating on AIA code, you can run the following commands:

1. Start AIA:

   npm start

2. Hack, hack, hack

3. Check if everything still runs in production mode:

   npm run build
   npm install -g serve
   serve -s build

4. Create tests

5. Run all tests:

   npm test

6. Commit code and create a pull request

Test suite

The tests can be started via:

npm test

If you run into any trouble, please check the available npm scripts and the Jest documentation.

Create new algorithms

Follow the instructions in the algorithms README.

Report a bug

If you'd like to report a bug, please open an issue.

Propose a change

If you'd like to propose a change, please open a pull request.