Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Indicate this package is for the whole Open edX project #37

Merged
merged 1 commit into from
Oct 25, 2023
Merged

fix: Indicate this package is for the whole Open edX project #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# edX Stylelint configs
# Open edX Stylelint configs
[![Build Status](https://github.com/openedx/stylelint-config-edx/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/openedx/stylelint-config-edx/actions?query=workflow%3A%22Node+CI%22)

# Purpose
Stylelint configs for edX Sass files.
Stylelint configs for Open edX Sass files.

## Table of Contents

- [edX Stylelint configs](#edx-stylelint-configs)
- [Open edX Stylelint configs](#open-edx-stylelint-configs)
- [Purpose](#purpose)
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
Expand All @@ -16,9 +16,9 @@ Stylelint configs for edX Sass files.

## Overview

In order to standardize and enforce edX's Sass coding style across
multiple codebases, edX has adopted Stylelint. This package provides
the rules defined by the edX development community.
In order to standardize and enforce Open edX's Sass coding style across
multiple codebases, Open edX has adopted Stylelint. This package provides
the rules defined by the Open edX development community.

## License

Expand All @@ -28,7 +28,7 @@ file](https://github.com/openedx/stylelint-config-edx/blob/master/LICENSE) for d

## Usage

To begin using the edX Stylelint configs in a codebase, install this
To begin using the Open edX Stylelint configs in a codebase, install this
package from npm:

npm install --save-dev @edx/stylelint-config-edx
Expand All @@ -48,7 +48,7 @@ The simplest option is to add the following to a file

## Sass Style Guide

For the most part, edX follows the recommended SCSS rules defined
For the most part, Open edX follows the recommended SCSS rules defined
by the [stylelint-config-recommended-scss package](https://www.npmjs.com/package/stylelint-config-recommended-scss).

The only changes are that the following rules have been disabled:
Expand Down
Loading