Skip to content

Commit

Permalink
Initial
Browse files Browse the repository at this point in the history
  • Loading branch information
justinh-rahb committed Aug 17, 2023
1 parent b69db9e commit c81956f
Show file tree
Hide file tree
Showing 27 changed files with 595 additions and 356 deletions.
51 changes: 25 additions & 26 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
title: '[Bug] '
labels: 'bug'
assignees: 'justinh-rahb'

---

**Describe the bug**
A clear and concise description of what the bug is.
🐛 **Bug Report**

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Description:**
[Provide a clear and concise description of the bug you encountered.]

**Expected behavior**
A clear and concise description of what you expected to happen.
**Steps to Reproduce:**
1. [Outline the steps you took that led to the bug. Be specific and include any relevant details, such as input data or configuration settings.]

**Screenshots**
If applicable, add screenshots to help explain your problem.
**Expected Behavior:**
[Explain what you expected to happen when following the steps above.]

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Actual Behavior:**
[Describe what actually happened. If there was an error message, include it here.]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Screenshots / Code Snippets:**
[If applicable, include any relevant screenshots or code snippets that demonstrate the issue.]

**Additional context**
Add any other context about the problem here.
**Environment:**
- Operating System: [e.g., Windows 10, macOS Big Sur, Ubuntu 20.04, etc.]
- Browser (if applicable): [e.g., Chrome, Firefox, Safari, etc.]
- Application/Software Version: [e.g., Chat²GPT version or commit hash]
- OpenAI API Version (if applicable): [e.g., gpt-3.5-turbo]

**Additional Information:**
[Include any other relevant information that might help understand or troubleshoot the issue.]

**Possible Solution (Optional):**
[If you have any ideas on how to fix the bug, you can suggest a possible solution here.]
30 changes: 19 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
title: '[Feature Request] '
labels: 'enhancement'
assignees: 'justinh-rahb'

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
🚀 **Feature Request**

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Description:**
[Provide a clear and concise description of the new feature you'd like to see added.]

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Problem Statement:**
[Explain the problem or need that this feature would address. Describe the context and why the feature would be beneficial.]

**Additional context**
Add any other context or screenshots about the feature request here.
**Proposed Solution:**
[Offer your ideas on how this feature could be implemented or any suggestions on how it could work.]

**Benefits:**
[Highlight the potential benefits of adding this feature to the project.]

**Additional Context:**
[Include any additional information or context that might be relevant to the feature request.]

**Screenshots / Mockups (Optional):**
[If applicable, include any visual aids, such as screenshots or mockups, to help illustrate your idea.]
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Summary
Describe the changes made in this PR.

## Description
Provide a detailed description of the changes. Include the context and reasons for the changes made.

## Related Issue(s)
Link to the related issue(s).

## Motivation and Context
Explain why these changes were necessary.

## Types of changes
What types of changes does your code introduce? Put an `x` in all the boxes that apply:
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist:
Go over all the following points, and put an `x` in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help!
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
74 changes: 74 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"

on:
workflow_dispatch:
schedule:
- cron: '21 23 * * 1'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'python' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

steps:
- name: Checkout repository
uses: actions/checkout@v3

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
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
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
if [ -f requirements.txt ]; then pip3 install -r requirements.txt; fi
# 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

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{matrix.language}}"
63 changes: 63 additions & 0 deletions .github/workflows/python-3.11.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Continuous Integration

on:
push:
branches:
- 'master'
pull_request:

permissions:
contents: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.11
uses: actions/setup-python@v4
with:
python-version: "3.11"
cache: "pip" # caching pip dependencies
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install flake8
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10", "3.11"]
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pylint
- name: Analysing the code with pylint
run: |
pylint -E -d import-error $(git ls-files '*.py')
dependabot:
name: 'Dependabot'
needs: [build, test] # After the build and test jobs, if one of them fails, it won't merge the PR.
runs-on: ubuntu-latest
if: ${{ github.actor == 'dependabot[bot]' && github.event_name == 'pull_request'}} # Detect that the PR author is dependabot
steps:
- name: Enable auto-merge for Dependabot PRs
run: gh pr merge --auto --merge "$PR_URL" # Use Github CLI to merge automatically the PR
env:
PR_URL: ${{github.event.pull_request.html_url}}
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
37 changes: 0 additions & 37 deletions .github/workflows/python.yml

This file was deleted.

Loading

0 comments on commit c81956f

Please sign in to comment.