diff --git a/.github/workflows/lint-pull-request.yml b/.github/workflows/lint-pull-request.yml deleted file mode 100644 index 95c01a2b..00000000 --- a/.github/workflows/lint-pull-request.yml +++ /dev/null @@ -1,112 +0,0 @@ -name: Lint pull request - -on: - pull_request_target: - branches: - - "main" - - "v[0-9]*" - types: - - opened - - edited - - unlabeled - - ready_for_review - -concurrency: - group: >- - ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: true - -permissions: - pull-requests: write - -jobs: - title: - runs-on: ubuntu-latest - if: ${{ !github.event.pull_request.draft }} - - steps: - - uses: amannn/action-semantic-pull-request@v6.1.1 - id: lint_pr_title - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - types: | - feat - fix - docs - style - refactor - perf - test - build - ci - chore - revert - plan - subjectPattern: ^([A-Z]).+$ - subjectPatternError: > - The subject "**{subject}**" must start with an uppercase character. - Example: "Add feature" instead of "add feature" - ignoreLabels: | - bot - dependencies - automated - - - uses: marocchino/sticky-pull-request-comment@v2.9.4 - if: always() && (steps.lint_pr_title.outputs.error_message != null) - with: - header: pr-title-lint-error - message: | - ### ⚠️ Invalid Pull Request title - - Your PR title must follow the format: `type: Subject` where: - - `type` is one of the conventional commit types (in lowercase) - - `Subject` starts with an uppercase letter - - > [!CAUTION] - > ${{ steps.lint_pr_title.outputs.error_message }} - - #### Valid examples - - - `feat: Add API endpoint for market data` - - `fix: Resolve WebSocket connection issues` - - `plan: Define technical implementation approach` - - `chore: Update NuGet dependencies` - -
- see more valid examples - - #### Features & fixes - - `feat: Add API endpoint for market data` - - `fix: Resolve WebSocket connection issues` - - #### Planning & architecture - - `plan: Define technical implementation approach` - - #### Code quality - - `style: Format trading strategy classes` - - `refactor: Restructure trading engine components` - - `perf: Optimize trade order execution flow` - - #### Documentation & testing - - `docs: Update API documentation` - - `test: Add unit tests for sign-in flow` - - #### Infrastructure - - `build: Update .NET SDK version to 10.0` - - `ci: Add workflow for performance testing` - - `chore: Update NuGet dependencies` - - #### Other - - `revert: Remove faulty market data provider` - - See [Conventional Commits](https://www.conventionalcommits.org) - for more details. -
- - # Delete a previous comment when the issue has been resolved - - if: ${{ steps.lint_pr_title.outputs.error_message == null }} - uses: marocchino/sticky-pull-request-comment@v2.9.4 - with: - header: pr-title-lint-error - delete: true diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..afc4ecaf --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,12 @@ +# stock-indicators-python + +Stock Indicators for Python — a PyPI library that transforms raw OHLCV price quotes into technical indicators such as moving averages, RSI, and Stochastic Oscillator for equities, commodities, forex, and cryptocurrencies. + +## Pull request conventions + +PR titles must follow Conventional Commits format: `type: Subject` + +- `type` is lowercase: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`, `plan` +- `Subject` starts with an uppercase letter; keep total title length ≤ 65 characters + +Ignore this convention for PRs labeled `bot`, `dependencies`, or `automated`.