Skip to content

Commit 9debfb2

Browse files
committed
Add config files and update docs for tooling support
Added .nvmrc to specify Node.js 22, .stylelintrc.json for Stylelint SCSS rules, and stackblitz.json for StackBlitz integration. Introduced CONTRIBUTING.md with guidelines. Updated README.md with StackBlitz badge and package.json to enforce Node.js >=22.0.0 in engines.
1 parent 6331f04 commit 9debfb2

6 files changed

Lines changed: 68 additions & 0 deletions

File tree

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
22

.stylelintrc.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"extends": ["stylelint-config-standard-scss"],
3+
"rules": {
4+
"scss/at-rule-no-unknown": [
5+
true,
6+
{
7+
"ignoreAtRules": ["use", "forward", "import", "mixin", "include", "function", "return", "if", "else", "each", "for", "while", "extend"]
8+
}
9+
],
10+
"selector-class-pattern": null,
11+
"no-descending-specificity": null,
12+
"property-no-vendor-prefix": null,
13+
"value-no-vendor-prefix": null
14+
}
15+
}

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to Stylescape Examples
2+
3+
Thank you for your interest in contributing to Stylescape!
4+
5+
## Getting Started
6+
7+
1. Fork this repository
8+
2. Clone your fork locally
9+
3. Install dependencies: `npm install`
10+
4. Start development: `npm run dev`
11+
12+
## Guidelines
13+
14+
- Follow the existing code style
15+
- Test your changes locally before submitting
16+
- Keep commits focused and descriptive
17+
- Update documentation if needed
18+
19+
## Reporting Issues
20+
21+
- Check existing issues first
22+
- Provide clear reproduction steps
23+
- Include environment details (Node version, OS, browser)
24+
25+
## Pull Requests
26+
27+
1. Create a feature branch from `main` or `dev`
28+
2. Make your changes
29+
3. Test thoroughly
30+
4. Submit a PR with a clear description
31+
32+
## Code of Conduct
33+
34+
Please be respectful and inclusive. See our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
35+
36+
## Questions?
37+
38+
- Open an issue for questions
39+
- Visit [Stylescape Documentation](https://github.com/stylescape/stylescape)
40+
41+
## License
42+
43+
By contributing, you agree that your contributions will be licensed under the MIT License.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Stylescape Parcel Example
22

3+
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/stylescape/example-parcel)
4+
35
This example demonstrates how to integrate [Stylescape](https://github.com/stylescape/stylescape) with [Parcel](https://parceljs.org/), a zero-configuration web application bundler.
46

57
## About Stylescape

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
"private": true,
66
"repository": "https://github.com/stylescape/example-parcel",
77
"license": "MIT",
8+
"engines": {
9+
"node": ">=22.0.0"
10+
},
811
"stackblitz": {
912
"startCommand": "npm start"
1013
},

stackblitz.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"installDependencies": true,
3+
"startCommand": "npm run dev"
4+
}

0 commit comments

Comments
 (0)