From 8d556b210e0ceaef28948797799049075870e9f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ulises=20Gasc=C3=B3n?= Date: Wed, 26 Jun 2024 09:56:08 +0200 Subject: [PATCH] Revert "Merge branch 'docs/improve-contributing-guide' of https://github.com/UlisesGascon/openssf-scorecard-monitor into docs/improve-contributing-guide" This reverts commit 91f8bb95848e0db086b91e012b209afc46a3365d, reversing changes made to 9b7101a563b40753f5d84e29c961b80469ca1a25. --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 02b6215..2b7e05e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,8 @@ project. This document describes the contribution guidelines for the project. ### Getting started 1. Create [a GitHub account](https://github.com/join) -1. Create a [personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) +1. Create a + [personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) 1. Set up your [development environment](#environment-setup) ### Environment Setup @@ -56,8 +57,8 @@ We recommend starting with several resources from the official Node.js website: ## Contributing steps 1. Identify an existing issue you would like to work on, or submit an issue describing your proposed change to the repo in question. -1. The maintainers will respond to your issue promptly. -1. Fork this repo, develop, and test your code changes. +1. The repo owners will respond to your issue promptly. +1. Fork the desired repo, develop and test your code changes. 1. Submit a pull request. ## How to run the Scorecard Monitor locally @@ -70,7 +71,7 @@ Aside from this, it is possible to test certain things locally, like the `utils. First, check that you are using Node v20+ and then execute `npm ci` instead of `npm i` or `npm install` as you want to mimic the pipeline steps in order to avoid discrepancies later on with the `dist/` as the dependencies are included there. -## Running tests +## How to run the tests Currently, the project is using [Jest](https://jestjs.io/) and [Snapshot Testing](https://jestjs.io/docs/snapshot-testing). @@ -80,7 +81,7 @@ You have several options to run the tests: - `npm run test:coverage` this will run the tests and generate a coverage report as terminal output and in HTML format that can be found in the `coverage/` folder - `npm run test:watch`: this will run the tests when you make changes in any of the project's files. -## Linting the codebase +## How to run the linter This project uses [JavaScript Standard Style](https://standardjs.com/). If you are not familiar with this style, you can make your changes and run `npm run lint:fix` when you are ready. The linter will fix most of the issues for you and it will highlight any additional issue that requires manual work.