Mushroom Observer

Last Revised: 2023-01-08

This README is an overview of

the tools used by Mushroom Observer (MO) and
the other READMEs in this repository.

See https://mushroomobserver.org/info/intro for an introduction to the website itself.

TOOLS

git

MO uses git for version control and management of MO code. The source code is hosted on github. The URL for the MO source repository is https://github.com/MushroomObserver/mushroom-observer.

Github Actions

We use Github Actions to implement Continuous Integration (CI). Pushing a commit to GitHub triggers a workflow run that includes:

testing with minitest,
submitting the results to Coveralls to get a coverage report,
running Codeclimate to get a quality control report.

minitest

Our test suite uses minitest and extensions. See our Gemfile for more details. The test suite is run as part of our CI, and also can be run locally.

We use Coveralls to obtain a report about test coverage. Coveralls is run as part of our CI, and also can be run locally. Its reports include total coverage and coverage for each line of code. The reports highlight newly uncovered lines so that we can maintain a high degree of coverage.

Codeclimate

We use Codeclimate and plugins, like RuboCop and Brakeman, to help maintain and improve code quality, including a consistent style. See our Codeclimate configuration file for more details.

RuboCop

We use RuboCop and extensions to help with code quality and consistentcy of style. See our RuboCop configuration file for more details. RuboCop is run as part of our CI, and also can be run locally. (We are a long way from where we want to be. We have hundreds of offenses to fix. See our Ruboco Todo file.)

Brakeman

We use Brakeman to highight some security issues.

DEVELOPMENT

To get started developing we recommend that you head over to https://github.com/MushroomObserver/developer-startup which provides instructions for getting a virtual machine development environment set up on Mac, Linux and Windows machines.