Skip to content

Commit

Permalink
perf: setup all the config files #13
Browse files Browse the repository at this point in the history
  • Loading branch information
rmenner committed Nov 26, 2024
1 parent 946b443 commit 6076315
Show file tree
Hide file tree
Showing 22 changed files with 3,366 additions and 216 deletions.
18 changes: 18 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

# Matches multiple files with brace expansion notation
# Set default charset
charset = utf-8

# Indentation override for all JS under lib directory
indent_style = space
indent_size = 2
20 changes: 10 additions & 10 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ our community a harassment-free experience for everyone, regardless of age, body

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Expand Down
36 changes: 19 additions & 17 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,48 +52,50 @@ The default graphite width of 10mm is always used for performance reasons.
```

#### MINOR

```
feat(pencil): add 'graphiteWidth' option
```

#### PATCH

```
fix(pencil): stop graphite breaking when too much pressure applied
```

#### Other commit types

| type | description |
|---|---|
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| docs | Documentation only changes |
| feat | A new feature (this correlates with `MINOR` in semantic versioning) |
| fix | A bug fix (this correlates with `PATCH` in semantic versioning) |
| perf | A code change that improves performance |
| BREAKING CHANGE | A code change that is not backwards compatible (correlating with `MAJOR` in semantic versioning) |
| refactor | A code change that neither fixes a bug nor adds a feature |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| test | Adding missing tests or correcting existing tests |
| type | description |
| --------------- | ----------------------------------------------------------------------------------------------------------- |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| docs | Documentation only changes |
| feat | A new feature (this correlates with `MINOR` in semantic versioning) |
| fix | A bug fix (this correlates with `PATCH` in semantic versioning) |
| perf | A code change that improves performance |
| BREAKING CHANGE | A code change that is not backwards compatible (correlating with `MAJOR` in semantic versioning) |
| refactor | A code change that neither fixes a bug nor adds a feature |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| test | Adding missing tests or correcting existing tests |

#### Git commit messages

Once you have completed your feature update, please commit all changes to the branch. All commit messages should use an **imperative mood**.

Imperative mood simply means _“spoken or written as if giving a command or instruction”_. A few examples are:

* Clean your room
* Close the door
* Take out the trash
- Clean your room
- Close the door
- Take out the trash

A properly formed Git commit subject line should always be able to complete the following sentence:

_"If applied, this commit will (your subject line here)."_

For example:

* If applied, this commit will `refactor component X for accessibility`
* If applied, this commit will `add feature Y to component X`
- If applied, this commit will `refactor component X for accessibility`
- If applied, this commit will `add feature Y to component X`

Example messages when using Conventional Commits:

Expand Down
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Bug report
description: Create a report to help us improve
title: '[issue summary] Please verify version before submitting new issue'
title: "[issue summary] Please verify version before submitting new issue"
labels:
- auro-cli
body:
Expand Down Expand Up @@ -31,7 +31,8 @@ body:
id: expected
attributes:
label: Expected behavior
description: Please add a clear and concise description of what you expected to
description:
Please add a clear and concise description of what you expected to
happen.
- type: dropdown
id: os
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Feature request
description: Suggest an idea for this project
title: 'auro-cli: [feature summary]'
title: "auro-cli: [feature summary]"
labels:
- auro-cli
body:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/general-support.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: General support
description: Suggestions that are not related to bugs or new features
title: 'auro-cli: [issue]'
title: "auro-cli: [issue]"
labels:
- auro-cli
body:
Expand Down
77 changes: 39 additions & 38 deletions .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,73 +99,74 @@ labels:
- name: good first issue
description: Good for newcomers
aliases:
- beginner-friendly
- beginner
- good-starter-issue
- good for beginner
- Good for beginners
- starter-issue
- starter
- beginner-friendly
- beginner
- good-starter-issue
- good for beginner
- Good for beginners
- starter-issue
- starter
- name: help wanted
description: Extra attention is needed, this user requires assistance to complete
description:
Extra attention is needed, this user requires assistance to complete
the work
- name: released
description: Completed work has been released
- name: 'Status: Work In Progress'
- name: "Status: Work In Progress"
description: Issue or Pull Request work is in Progress
- name: 'Status: Review Needed'
- name: "Status: Review Needed"
description: Work is completed, user is requesting feedback
- name: 'Status: Complete'
- name: "Status: Complete"
description: Owner has completed work and considers it ready to be merged
- name: 'Status: Blocked'
- name: "Status: Blocked"
description: Progress on the issue is Blocked, immediate attention is required
aliases:
- blocked
- name: 'Abandoned'
- blocked
- name: "Abandoned"
description: The author of this issue or Pull Request is not responding
aliases:
- wontfix
- invalid
- name: 'Type: Bug'
- wontfix
- invalid
- name: "Type: Bug"
description: Bug or Bug fixes
aliases:
- bug
- name: 'Type: Feature'
- bug
- name: "Type: Feature"
description: New Feature
aliases:
- enhancement
- name: 'Type: Design'
- enhancement
- name: "Type: Design"
description: New Design
aliases:
- enhancement
- name: 'Type: Content'
- enhancement
- name: "Type: Content"
description: Adding or editing content
aliases:
- enhancement
- name: 'Type: Refactoring'
- enhancement
- name: "Type: Refactoring"
description: A code change that neither fixes a bug nor adds a feature
aliases:
- refactor
- name: 'Type: Documentation'
- refactor
- name: "Type: Documentation"
description: Documentation only changes
aliases:
- documents
- document
- name: 'Type: CI'
- documents
- document
- name: "Type: CI"
description: Changes to CI configuration files and scripts
aliases:
- ci
- name: 'Type: Perf'
- ci
- name: "Type: Perf"
description: Performance update to existing code
- name: 'Question'
- name: "Question"
description: Further information is requested
aliases:
- question
- name: 'Type: Dependencies'
- question
- name: "Type: Dependencies"
description: Pull requests that update a dependency file
aliases:
- dependencies
- name: 'Type: UI Update'
- dependencies
- name: "Type: UI Update"
description: Changes to the user interface
aliases:
- dependencies
- dependencies
3 changes: 1 addition & 2 deletions .github/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,5 @@ markComment: >
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: This issue has been automatically closed because it has not had
closeComment: This issue has been automatically closed because it has not had
recent activity. Thank you for your contributions.

61 changes: 30 additions & 31 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ name: "CodeQL"

on:
push:
branches: [ "main" ]
branches: ["main"]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "main" ]
branches: ["main"]

jobs:
analyze:
Expand All @@ -19,40 +19,39 @@ jobs:
strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
language: ["javascript"]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

steps:
- name: Checkout repository
uses: actions/[email protected]

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality


# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
# - name: Autobuild
- name: Checkout repository
uses: actions/[email protected]

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
# - name: Autobuild
# uses: github/codeql-action/autobuild@v2

# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh
# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
.DS_Store
node_modules/
docTemplates/
.cache/
.eslintcache

## Code coverage reports
coverage/
1 change: 1 addition & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx --no-install commitlint --edit "$1"
9 changes: 9 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# standard ignore
*config*
*conf*
LICENSE
NOTICE

.github/
.gitignore
eslint.config.js
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"cSpell.words": [
"auro"
]
}
Empty file added CHANGELOG.md
Empty file.
Loading

0 comments on commit 6076315

Please sign in to comment.