chore(release): 3.0.0 Release

.eslintrc.json

@@ -5,27 +5,67 @@
     },
     "extends": [
         "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-type-checked"
     ],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
         "ecmaVersion": 12,
-        "sourceType": "module"
+        "sourceType": "module",
+        "project": true
     },
     "plugins": [
         "@typescript-eslint"
     ],
     "rules": {
-        "eol-last": ["warn", "always"],
-        "semi-style": ["warn", "last"],
-        "semi": 2,
+        "brace-style": ["warn", "1tbs"],
+        "camelcase": ["warn", {
+            "properties": "never",
+            "ignoreImports": true
+        }],
         "comma-dangle": ["error", "never"],
+        "comma-spacing": ["warn", {
+            "after": true,
+            "before": false
+        }],
         "comma-style": ["warn", "last"],
-        "no-unused-vars": 1,
+        "curly": ["error", "all"],
+        "default-case": 1,
+        "eol-last": ["warn", "always"],
+        "indent": ["warn", 4, {
+            "SwitchCase": 1
+        }],
+        "key-spacing": ["warn", {
+            "mode": "strict"
+        }],
+        "keyword-spacing": ["warn", {
+            "after": true,
+            "before": true
+        }],
+        "lines-between-class-members": ["warn", "always"],
+        "no-multi-spaces": 1,
+        "no-multiple-empty-lines": ["warn", { 
+            "max": 1
+        }],
         "no-trailing-spaces": 1,
+        "no-unused-vars": 1,
         "no-useless-escape": 0,
-        "@typescript-eslint/no-require-imports": 2,
-        "@typescript-eslint/no-var-requires": 0,
+        "object-curly-spacing": ["error", "always", { 
+            "objectsInObjects": true,
+            "arraysInObjects": true
+        }],
+        "quotes": ["warn", "double", {
+            "avoidEscape": false
+        }],
+        "semi": "error",
+        "semi-style": ["warn", "last"],
+        "sort-imports": ["warn", {
+            "ignoreCase": false,
+            "ignoreDeclarationSort": true
+        }],
+        "@typescript-eslint/explicit-function-return-type": ["warn", {
+            "allowExpressions": true
+        }],
         "@typescript-eslint/member-delimiter-style": ["warn", {
             "multiline": {
               "delimiter": "semi",
@@ -36,6 +76,10 @@
               "requireLast": false
             },
             "multilineDetection": "brackets"
-        }]
-    }
+        }],
+        "@typescript-eslint/no-unnecessary-condition": 2,
+        "@typescript-eslint/no-require-imports": 2,
+        "@typescript-eslint/no-var-requires": 1
+    },
+    "ignorePatterns": ["dist/*.js", "dist/**/*.js"]
 }

.github/ISSUE_TEMPLATE/Issues.yml

@@ -0,0 +1,50 @@
+name: "Bug Report"
+description: "Report a bug encountered while using the project."
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Welcome to the issue tracker!
+
+        Before submitting your issue, please make sure to provide as much relevant information as possible. 
+
+  - type: input
+    attributes:
+      label: Issue Description
+      description: Provide a brief description of the issue you are facing.
+
+  - type: input
+    attributes:
+      label: Expected Behavior
+      description: What should happen?
+
+  - type: input
+    attributes:
+      label: Actual Behavior
+      description: What is happening instead?
+
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: Describe the steps required to reproduce the issue, including code snippets, if relevant.
+
+  - type: input
+    attributes:
+      label: NodeJS Environment
+      description: NodeJS Version
+
+  - type: input
+    attributes:
+      label: Package Manager
+      description: NPM Version
+
+  - type: dropdown
+    attributes:
+      label: Operating System
+      options:
+        - Windows
+        - macOS
+        - Linux
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+## Changes
+<!---Describe what changes this PR includes-->
+

.github/workflows/build.yml

@@ -0,0 +1,26 @@
+name: Run TypeScript Compiler
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  lint:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        node-version: [18.19.0]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install npm
+      run: npm install npm@10.2.3 -g
+    - name: Install dependencies
+      run: npm ci
+    - name: Run typescript compiler
+      run: npm run build --if-present

.github/workflows/lint.yml

@@ -1,26 +1,26 @@
-name: eslint
+name: Run ESLint Linter
 
 on:
   push:
-    branches: [ main ]
+    branches: [ develop ]
   pull_request:
-    branches: [ main ]
+    branches: [ develop ]
 
 jobs:
   lint:
     runs-on: windows-latest
     strategy:
       matrix:
-        node-version: [16.19.0]
+        node-version: [18.19.0]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v2
       with:
         node-version: ${{ matrix.node-version }}
-    - name: install npm
-      run: npm install npm@8.19.3 -g
-    - name: install dependencies
+    - name: Install npm
+      run: npm install npm@10.2.3 -g
+    - name: Install dependencies
       run: npm ci
-    - name: run lint
-      run: npm run lint
+    - name: Run lint
+      run: npm run lint --if-present

.gitignore

@@ -5,3 +5,4 @@ npm-debug.log
 .env
 coverage
 lib
+dist

CONTRIBUTING.md

@@ -1,39 +1,60 @@
-## Contributing
+# Contribution Guide
 
-[fork]: /fork
-[pr]: /compare
-[code-of-conduct]: CODE_OF_CONDUCT.md
+Welcome to the contribution guide! I appreciate your interest in contributing to github-AutoResponse project. This guide will provide you with the necessary information and guidelines to make your contributions valuable and effective.
 
-Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+### 1. Getting started
 
-Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
+Contributions can come in various forms, including bug fixes, refactoring the code, documentation improvements, and more. Here are some ways you can contribute to the repository:
 
-## Issues and PRs
+- Fix bugs and address issues.
+- Refactor code for better maintainability.
+- Improve the documentation.
 
-If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
+If you're unsure about what to work on, you can check the repository's issue tracker for any open issues.
 
-We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
+### 2. Code Style and Guidelines
 
-## Submitting a pull request
+To maintain a consistent codebase, this project follow certain code style and guidelines. Please adhere to the following conventions when contributing code:
 
-1. [Fork][fork] and clone the repository.
-1. Configure and install the dependencies: `npm install`.
-1. Make sure the tests pass on your machine: `npm test`, note: these tests also apply the linter, so there's no need to lint separately.
-1. Create a new branch: `git checkout -b my-branch-name`.
-1. Make your change, add tests, and make sure the tests still pass.
-1. Push to your fork and [submit a pull request][pr].
-1. Pat your self on the back and wait for your pull request to be reviewed and merged.
+- Follow the code standard and writing style from ESLint config.
+- Use camelcase for variable, function, etc.
+- Write clear and concise comments when necessary (will remove after merging).
 
-Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+### 3. Running the Linter
 
-- Write and update tests.
-- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
-- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+This repository have a linter set up for the project to ensure consistent code style and catch potential issues. Before opening a pull request, please run the following command to execute the linter and fix any reported issues:
 
-Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
+```
+npm run lint
+```
 
-## Resources
+Make sure the linter passes without any errors or warnings before proceeding with your pull request. This step ensures that the codebase remains clean and consistent.
 
-- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
-- [GitHub Help](https://help.github.com)
+### 4. Using Conventional Commits
+
+To have a consistent commit message format across the repository, we follow the Conventional Commits specification. Please use the following format for your commit messages:
+
+```
+<type>[optional scope]: <description>
+```
+
+Here's an example of a conventional commit message:
+
+```
+feat(core): add issue_comment.created event
+```
+
+For more information about the Conventional Commits specification, you can refer to [conventionalcommits.org](https://conventionalcommits.org).
+
+### 5. Avoiding Copyright Infringement
+
+When contributing code or any other content, it's important to ensure that your contributions are your own original creation and do not violate any copyright laws or infringe upon the intellectual property rights of others. By contributing to this repository, you agree to the following:
+
+- You warrant that the contribution is your original work.
+- You agree to grant the repository maintainers and users a license to use your contributions under the repository's designated license. [LICENSE](https://github.com/Typeslint/github-AutoResponse/blob/main/LICENSE)
+
+Please refrain from including any code, documentation, or other content in your contributions that may have been copied or derived from copyrighted sources without the necessary permissions or licenses.
+
+### 6. LICENSE
+
+By contributing to this repository, you agree that your contributions will be licensed under the same license as the repository itself. Please refer to the repository's [LICENSE](https://github.com/Typeslint/github-AutoResponse/blob/main/LICENSE) file for more details.

Dockerfile

@@ -1,8 +1,8 @@
 FROM node:18
-WORKDIR /usr/src/app
+WORKDIR /app
 COPY package.json package-lock.json ./
-RUN npm ci --production
+RUN npm ci
 RUN npm cache clean --force
 ENV NODE_ENV="production"
 COPY . .
-CMD [ "npm", "start" ]
+CMD [ "npm", "run", "build:start" ]

LICENSE

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2021, Muunatic <125534A11B63B1FC>
+Copyright (c) 2021, Typeslint <support@typeslint.com>
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

README.md

@@ -1,33 +1,27 @@
-# GitHub-AutoResponse
+# github-AutoResponse
+This GitHub Automaton is a Probot-based application that automates various actions and responses to different events within a GitHub repository. It utilizes Probot, Octokit, and various event listeners to handle actions such as closing issues, commenting on issues and pull requests, managing pull requests, and performing checks on workflow runs.
 
-> A GitHub App built with [Probot](https://github.com/probot/probot) framework
+## Features
+- Push Event Handling: Responds to push events in the repository.
+- Issues Management: Handles opening, closing, and commenting on issues.
+- Pull Request Management: Manages opening, reviewing, and synchronizing pull requests.
+- Workflow Run Handling: Performs checks based on workflow run completion events.
+- Stale Pull Requests: Regularly checks for stale pull requests.
 
-## Setup
+## Configuration
+Environment Variables
+To use this application, set the following environment variables in a .env file:
 
-```sh
-# Install dependencies
-npm install
+APP_ID: Your GitHub App's ID.
+PRIVATE_KEY: Your GitHub App's private key.
+CLIENT_ID: Your GitHub App's client ID.
+CLIENT_SECRET: Your GitHub App's client secret.
 
-# Run the client
-npm start
-```
-
-## Docker
-
-```sh
-# 1. Build container
-docker build -t my-first-app .
-
-# 2. Start container
-docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> my-first-app
-```
+## Usage
+To use this application, install the dependencies and configure the environment variables. Run the application using the appropriate command `npm run build:start`.
 
 ## Contributing
-
-If you have suggestions for GitHub-AutoResponse could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
-
-For more, check out the [Contributing Guide](CONTRIBUTING.md).
+Contributions are welcome! Please see this <a href="https://github.com/Typeslint/github-AutoResponse/blob/main/CONTRIBUTING.md">**Contribution Guide**</a> and adhere to <a href="https://github.com/Typeslint/github-AutoResponse/blob/main/CODE_OF_CONDUCT.md">**Code Of Conduct**</a>. If you have any improvements, feel free to submit a pull request.
 
 ## License
-
-[ISC](LICENSE) © 2021 Muunatic
+This project is licensed under the MIT License.

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+To report a security vulnerability, please send an email to [support@typeslint.com](mailto:support@typeslint.com)