From 0a397ead746cfe71bb9c5eb0071ad659f8d31e2f Mon Sep 17 00:00:00 2001 From: Harry Lascelles Date: Sun, 20 Jul 2025 19:09:31 +0100 Subject: [PATCH] Add specs and linter documentation --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12f06e044..d122fd818 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,3 +13,20 @@ Here are some reasons why a pull request may not be merged: If you would like to help in this process, you can start by evaluating open pull requests against the criteria above. For example, if a pull request does not include specs for new functionality, you can add a comment like: “If you would like this feature to be added to Thor, please add specs to ensure that it does not break in the future.” This will help move a pull request closer to being merged. Include this emoji in the top of your ticket to signal to us that you read this file: 🌈 + +Specs +----- + +Ensure that all specs and code linting checks pass before submitting a pull request. + +To execute the specs locally, run: + +```bash +bundle exec rspec +``` + +Linting checks are done with RuboCop. To run the linter, use: + +```bash +bundle exec rubocop +```