Skip to content

Commit

Permalink
Merge branch 'main' into docs-prep
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleTryon committed Aug 12, 2022
2 parents a3df6ef + 456fbc7 commit e10400a
Show file tree
Hide file tree
Showing 17 changed files with 1,987 additions and 51 deletions.
4 changes: 4 additions & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx --no -- commitlint --edit "${1}"
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm run prettier && npm run lint && npm run test
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ Scopes can be used to denote which package this change is affecting
- _**sdk**_: The CircleCI Configuration SDK
- **parser**: The CircleCI Configuration Parser


#### <a name="pull"></a>Submitting a Pull Request

After searching for potentially existing pull requests or issues in progress, if
Expand All @@ -144,9 +143,9 @@ After the issue has been created, follow these steps to create a Pull Request.
1. Run `npm run setup`
1. Implement your change with appropriate test coverage.
1. Utilize our [commit message conventions](commit).
2. Run tests, linters, and formatters locally, with: `npm run prep`
3. Push all changes back to GitHub `git push origin fix_my_issue`
4. In GitHub, send a Pull Request to `circleci-config-sdk-ts:main`
1. Run tests, linters, and formatters locally, with: `npm run prep`
1. Push all changes back to GitHub `git push origin fix_my_issue`
1. In GitHub, send a Pull Request to `circleci-config-sdk-ts:main`

Thank you for your contribution!

Expand Down
1 change: 1 addition & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = { extends: ['@commitlint/config-conventional'] };
Loading

0 comments on commit e10400a

Please sign in to comment.