## 1. Project Overview & Quickstart (rspec/CODE_OF_CONDUCT)

## 1. Project Overview & Quickstart (rspec/CODE_OF_CONDUCT)

# CODE_OF_CONDUCT

Open-source repository rspec/CODE_OF_CONDUCT

### Repository Details
- **Repository:** [rspec/CODE_OF_CONDUCT](https://github.com/rspec/CODE_OF_CONDUCT)
- **Primary Language:** Code

*Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.*

## 2. Official Technical Reference & Guides (rspec/rspec.github.io)

rspec.github.io
===============

Source for https://rspec.info

Requires a recent version of Ruby (tested on 2.7.5, Ruby 3.x is not yet working), bundler and imagemagick (to generate favicons).

## Local Setup

* `brew install imagemagick` (or your package manager of choice).
* `brew install nodejs` (or your javascript runtime of choice for [execjs](https://github.com/rails/execjs)).
* `bundle install`
* `middleman build`

## Local Developing

Run `LIVERELOAD=true middleman server`

## Docker Setup + Development

If you don't have a local Ruby environment suitable to making changes to
rspec.info, or prefer containerised development; use the following scripts to
build the included Docker image and build the site in the containerised
environment instead.

```
# Start the middleman server. Access site at http://localhost:4567
bin/server

# Build the site in the `docs/` directory. Replacement for `middleman build`.
bin/build

# Start a console inside the docker container. Useful for debugging or running commands locally.
bin/console
```

## Deploying

We now use the Github action in `.github/workflows/middleman_deploy.yml` to automatically build
and deploy, builds are run on PR to ensure they "work" but you should check the artifacts locally
/ in the build before merging.

- To update [https://rspec-staging.github.io](https://rspec-staging.github.io) use repository https://github.com/RSpec-Staging/rspec-staging.github.io/.
- To update [https://rspec.info](https://rspec.info) use repository https://github.com/rspec/rspec.github.io/

## Credits

[Andrew Harvey](https://mootpointer.com) - for his incredible effort of making this repository as it is now

## 2. Official Technical Reference & Guides (rspec/rspec.github.io)

rspec.github.io
===============

Source for https://rspec.info

Requires a recent version of Ruby (tested on 2.7.5, Ruby 3.x is not yet working), bundler and imagemagick (to generate favicons).

## Local Setup

* `brew install imagemagick` (or your package manager of choice).
* `brew install nodejs` (or your javascript runtime of choice for [execjs](https://github.com/rails/execjs)).
* `bundle install`
* `middleman build`

## Local Developing

Run `LIVERELOAD=true middleman server`

## Docker Setup + Development

If you don't have a local Ruby environment suitable to making changes to
rspec.info, or prefer containerised development; use the following scripts to
build the included Docker image and build the site in the containerised
environment instead.

```
# Start the middleman server. Access site at http://localhost:4567
bin/server

# Build the site in the `docs/` directory. Replacement for `middleman build`.
bin/build

# Start a console inside the docker container. Useful for debugging or running commands locally.
bin/console
```

## Deploying

We now use the Github action in `.github/workflows/middleman_deploy.yml` to automatically build
and deploy, builds are run on PR to ensure they "work" but you should check the artifacts locally
/ in the build before merging.

- To update [https://rspec-staging.github.io](https://rspec-staging.github.io) use repository https://github.com/RSpec-Staging/rspec-staging.github.io/.
- To update [https://rspec.info](https://rspec.info) use repository https://github.com/rspec/rspec.github.io/

## Credits

[Andrew Harvey](https://mootpointer.com) - for his incredible effort of making this repository as it is now