Feature/add more GitHub docs

.github/ISSUE_TEMPLATE/01_BUG_REPORT.md

@@ -0,0 +1,37 @@
+---
+name: Bug Report
+about: Create a report to help PHPDoc Parser to improve
+title: 'bug: '
+labels: 'bug'
+assignees: ''
+---
+
+# Bug Report
+
+**PHPDoc Parser version:**
+
+<!-- Please specify commit or tag version. -->
+
+**Current behavior:**
+
+<!-- Describe how the bug manifests. -->
+
+**Expected behavior:**
+
+<!-- Describe what you expect the behavior to be without the bug. -->
+
+**Steps to reproduce:**
+
+<!-- Explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
+
+**Related code:**
+
+<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
+
+```
+insert short code snippets here
+```
+
+**Other information:**
+
+<!-- List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->

.github/ISSUE_TEMPLATE/02_FEATURE_REQUEST.md

@@ -0,0 +1,35 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: 'feat: '
+labels: 'enhancement'
+assignees: ''
+---
+
+# Feature Request
+
+**Describe the Feature Request**
+
+<!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. -->
+
+**Describe Preferred Solution**
+
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe Alternatives**
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Related Code**
+
+<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
+
+**Additional Context**
+
+<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. -->
+
+**If the feature request is approved, would you be willing to submit a PR?**
+_(Help can be provided if you need assistance submitting a PR)_
+
+- [ ] Yes
+- [ ] No

.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md

@@ -0,0 +1,7 @@
+---
+name: Codebase improvement
+about: Provide your feedback for the existing codebase. Suggest a better solution for algorithms, development tools, etc.
+title: 'dev: '
+labels: 'enhancement'
+assignees: ''
+---

.github/ISSUE_TEMPLATE/04_SUPPORT_QUESTION.md

@@ -0,0 +1,9 @@
+---
+name: Support Question
+about: Question on how to use this project
+title: 'support: '
+labels: 'question'
+assignees: ''
+---
+
+# Support Question

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+---
+blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,40 @@
+<!--- Please provide a general summary of your changes in the title above -->
+
+## Pull Request type
+
+<!-- Please try to limit your pull request to one type; submit multiple pull requests if needed. -->
+
+Please check the type of change your PR introduces:
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update (formatting, renaming)
+- [ ] Refactoring (no functional changes, no API changes)
+- [ ] Build-related changes
+- [ ] Documentation content changes
+- [ ] Other (please describe):
+
+## What is the current behavior?
+
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+Issue Number: N/A
+
+## What is the new behavior?
+
+<!-- Please describe the behavior or changes that are being added by this PR. -->
+
+-
+-
+-
+
+## Does this introduce a breaking change?
+
+- [ ] Yes
+- [ ] No
+
+<!-- If this does introduce a breaking change, please describe the impact and migration path for existing applications below. -->
+
+## Other information
+
+<!-- Any other information that is important to this PR, such as screenshots of how the component looks before and after the change. -->

.github/labels.yml

@@ -0,0 +1,78 @@
+---
+- name: 'breaking-change'
+  color: ee0701
+  description: 'A change that changes the API or breaks backward compatibility for users.'
+- name: 'bugfix'
+  color: ee0701
+  description: 'Inconsistencies or issues which will cause a problem for users or implementors.'
+- name: 'documentation'
+  color: 0052cc
+  description: 'Solely about the documentation of the project.'
+- name: 'enhancement'
+  color: 1d76db
+  description: 'Enhancement of the code, not introducing new features.'
+- name: 'refactor'
+  color: 1d76db
+  description: 'Updating the code with simpler, easier to understand or more efficient syntax or methods, but not introducing new features.'
+- name: 'performance'
+  color: 1d76db
+  description: 'Improving performance of the project, not introducing new features.'
+- name: 'new-feature'
+  color: 0e8a16
+  description: 'New features or options.'
+- name: 'maintenance'
+  color: 2af79e
+  description: 'Generic maintenance tasks.'
+- name: 'ci'
+  color: 1d76db
+  description: 'Work that improves the continuous integration.'
+- name: 'dependencies'
+  color: 1d76db
+  description: 'Change in project dependencies.'
+
+- name: 'in-progress'
+  color: fbca04
+  description: 'Issue is currently being worked on by a developer.'
+- name: 'stale'
+  color: fef2c0
+  description: 'No activity for quite some time.'
+- name: 'no-stale'
+  color: fef2c0
+  description: 'This is exempt from the stale bot.'
+
+- name: 'security'
+  color: ee0701
+  description: 'Addressing a vulnerability or security risk in this project.'
+- name: 'incomplete'
+  color: fef2c0
+  description: 'Missing information.'
+- name: 'invalid'
+  color: fef2c0
+  description: "This is off-topic, spam, or otherwise doesn't apply to this project."
+
+- name: 'beginner-friendly'
+  color: 0e8a16
+  description: 'Good first issue for people wanting to contribute to this project.'
+- name: 'help-wanted'
+  color: 0e8a16
+  description: 'We need some extra helping hands or expertise in order to resolve this!'
+
+- name: 'priority-critical'
+  color: ee0701
+  description: 'Must be addressed as soon as possible.'
+- name: 'priority-high'
+  color: b60205
+  description: 'After critical issues are fixed, these should be dealt with before any further issues.'
+- name: 'priority-medium'
+  color: 0e8a16
+  description: 'This issue may be useful, and needs some attention.'
+- name: 'priority-low'
+  color: e4ea8a
+  description: 'Nice addition, maybe... someday...'
+
+- name: 'major'
+  color: b60205
+  description: 'This PR causes a major bump in the version number.'
+- name: 'minor'
+  color: 0e8a16
+  description: 'This PR causes a minor bump in the version number.'

.github/workflows/codeql.yml

@@ -0,0 +1,20 @@
+---
+name: CodeQL
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '30 1 * * 0'
+
+jobs:
+  codeql:
+    name: 🏭 Scanning
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v2
+      - name: 🏗 Initialize CodeQL
+        uses: github/codeql-action/init@v1
+      - name: 🚀 Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/labels.yml

@@ -0,0 +1,21 @@
+---
+name: Sync labels
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .github/labels.yml
+
+jobs:
+  labels:
+    name: ♻️ Sync labels
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v2
+      - name: 🚀 Run Label Syncer
+        uses: micnncim/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lock.yml

@@ -0,0 +1,32 @@
+---
+name: Lock
+
+on:
+  schedule:
+    - cron: '0 9 * * *'
+  workflow_dispatch:
+
+jobs:
+  lock:
+    name: 🔒 Lock closed issues and PRs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/[email protected]
+        with:
+          github-token: ${{ github.token }}
+          issue-lock-inactive-days: '30'
+          issue-lock-reason: ''
+          issue-comment: >
+            Issue closed and locked due to lack of activity.
+
+            If you encounter this same issue, please open a new issue and refer
+            to this closed one.
+          pr-lock-inactive-days: '1'
+          pr-lock-reason: ''
+          pr-comment: >
+            Pull Request closed and locked due to lack of activity.
+
+            If you'd like to build on this closed PR, you can clone it using
+            this method: https://stackoverflow.com/a/14969986
+
+            Then open a new PR, referencing this closed PR in your message.

.github/workflows/pr-labels.yml

@@ -0,0 +1,20 @@
+---
+name: PR Labels
+
+on:
+  pull_request:
+    types: [opened, labeled, unlabeled, synchronize]
+
+jobs:
+  pr_labels:
+    name: 🏭 Verify
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🏷 Verify PR has a valid label
+        uses: jesusvasquez333/[email protected]
+        with:
+          github-token: '${{ secrets.GITHUB_TOKEN }}'
+          valid-labels: >-
+            breaking-change, bugfix, documentation, enhancement,
+            refactor, performance, new-feature, maintenance, ci, dependencies
+          disable-reviews: true

.github/workflows/stale.yml

@@ -0,0 +1,44 @@
+---
+name: Stale
+
+on:
+  schedule:
+    - cron: '0 8 * * *'
+  workflow_dispatch:
+
+jobs:
+  stale:
+    name: 🧹 Clean up stale issues and PRs
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🚀 Run stale
+        uses: actions/stale@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          days-before-stale: 30
+          days-before-close: 7
+          remove-stale-when-updated: true
+          stale-issue-label: 'stale'
+          exempt-issue-labels: 'no-stale,help-wanted'
+          stale-issue-message: >
+            There hasn't been any activity on this issue recently, and in order
+            to prioritize active issues, it will be marked as stale.
+
+            Please make sure to update to the latest version and
+            check if that solves the issue. Let us know if that works for you
+            by leaving a 👍
+
+            Because this issue is marked as stale, it will be closed and locked
+            in 7 days if no further activity occurs.
+
+            Thank you for your contributions!
+          stale-pr-label: 'stale'
+          exempt-pr-labels: 'no-stale'
+          stale-pr-message: >
+            There hasn't been any activity on this pull request recently, and in
+            order to prioritize active work, it has been marked as stale.
+
+            This PR will be closed and locked in 7 days if no further activity
+            occurs.
+
+            Thank you for your contributions!

README.md

@@ -129,6 +129,8 @@ We are stilling waiting for someones to contribute, especially for the following
 - More docs
 - A script to monitor [upstream](https://github.com/phpstan/phpdoc-parser) updates and notify the author to catch up.
 
+Please check out our [Contribution guide](docs/CONTRIBUTING.md)
+
 ## How did we create the initial version of this project.
 
 We created most of our code by using ChatGPT as a tool to transform most code from https://github.com/phpstan/phpdoc-parser to TypeScript version.