Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

96 lines (66 loc) · 4.51 KB
Raw

Thanks for your interest in Nucleogenesis! This document describes how you can collaborate with the project.

Get involved

  • We use Github to report bugs. If you find a bug, please open an issue.
  • We use Github for task management. You can open a new issue to suggest features or enhancements.
  • We use a Fork-PR workflow to accept code changes. In the issue tracker we keep a list of features and enhancements that we plan to work on.
  • The Wiki is open for collaborators. Feel free to add or improve information for other players.

Issues

We categorise Github issues in the following categories.

  • feature: A new mechanic or system to be added.
  • enhancement: Improvement of existing systems. Generally speaking have lower priority than features.
  • content: Filling in in-game data. Usually busy work.
  • bug: Errors and problems with the code. They are fixed as they are reported.

We divide issues in rough sizes according to their size and complexity. We use size l, m and s.

Developers

Quickstart

If you haven't done this before:

sudo apt-get install npm nodejs-legacy # This turns out to be right but it feels *so wrong*
sudo npm install -g bower

To clone & build

git clone https://github.com/angarg12/nucleogenesis.git
cd nucleogenesis
npm install
gulp build

The build/ folder will include a working copy of the game.

Stack

Nucleogenesis uses the following technologies/tools:

Environments: src vs build vs dist

Nucleogenesis is divided in 3 environments; src, build and dist.

The src folder contains the source code for data, views and code, split in several files. Some of these scripts have lodash templates. This code needs to be processed to be executed.

The build environment generates derived data from the source code, and fills in the lodash templates. A build step downloads the runtime dependencies and places files in the right structure. It also packs all JS source files and data together in a single file. Code in the build environment can be executed.

The dist environment generates the final distributable code from the Build environment. It minifies the code and removes unnecessary source files. Optionally, this step can perform extra sanity checks.

Code structure

The main files/folder are:

  • package.json: Development dependencies.
  • bower.json: Runtime dependencies.
  • Gulpfile.js: Gulp tasks definition.
  • build_scripts: Contains scripts that run during the build step. The generate derived data and fill in source templates.
  • test/integration: e2e tests.
  • test/unit: Unit tests.
  • src/data: Game data. Mostly json files.
  • src/html: HTML views.
  • src/styles: CSS styles.
  • src/scripts/component: Components for the game views. Roughly speaking each tab in the game is a view/component pair.
  • src/scripts/controllers/main-loop.js: Game main loop.
  • src/scripts/services: Services with common functionality that span several components. For instance, util or savegame.

Gulp tasks

Gulp has the following public tasks:

  • build: Builds the code.
  • build-unit-test: Builds the code and runs unit tests on it.
  • dist: Builds the distributable code.
  • unit-test: Builds the distributable code and runs unit tests on it.
  • e2e-test: Builds the distributable code and runs end-to-end tests on it.
  • test: Builds the distributable code and runs unit and end-to-end tests on it.

Good practices

We run CI and code analysis on the code in master and for each PR. We try to maintain high quality code by using good programming practices, testing and reviews.

While coding, we recommend to run build-unit-test often to check that no unintended effects are introduced. Before submitting a PR, a full test should be run to check the build integrity.

Use tasks to discuss implementation or design of features. The PRs will be used to review and comment on the code. PRs that break the build, don't provide enough testing or enough quality will require changes.