Skip to content

Commit

Permalink
Project: initial project setup (#3)
Browse files Browse the repository at this point in the history
* Project: initial project setup

* Readme: fix

* Readme: fix

* Readme: fix
  • Loading branch information
IceKhan13 authored Aug 9, 2021
1 parent 247ac2f commit 50a6698
Show file tree
Hide file tree
Showing 22 changed files with 947 additions and 4 deletions.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: 🐛 Bug report
about: Create a report to help us improve 🤔.
labels: bug
---

<!-- ⚠️ If you do not respect this template, your issue will be closed -->
<!-- ⚠️ Make sure to browse the opened and closed issues -->

### Steps to reproduce the problem

### What is the current behavior?

### What is the expected behavior?
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: 💅 Enhancement request
about: Suggest an improvement for this project 🆒!
labels: 'type: enhancement'
---

<!-- ⚠️ If you do not respect this template, your issue will be closed -->
<!-- ⚠️ Make sure to browse the opened and closed issues to confirm this idea does not exist. -->

### What is the expected enhancement?

10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: 🚀 Feature request
about: Suggest an idea for this project 💡!
labels: 'type: feature request'
---

<!-- ⚠️ If you do not respect this template, your issue will be closed -->
<!-- ⚠️ Make sure to browse the opened and closed issues to confirm this idea does not exist. -->

### What is the expected behavior?
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/submission.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Project submission
description: Ecosystem project submission
title: "[Submission]: "
labels: []
assignees:
- octocat
body:
- type: markdown
attributes:
value: |
Provide information about your project.
- type: input
id: repo
attributes:
label: Github repo
description: Link to your github repo with project you want to submit
placeholder: https://github.com/Qiskit/qiskit-terra
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Short description of the project.
placeholder: Tell us about your work!
value: "..."
validations:
required: true
- type: input
id: contacts
attributes:
label: Email
description: Your contact information
placeholder: awesome_person@awesome_main.com
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Short description of alternative projects.
placeholder: There are no alternatives to this project!
validations:
required: false
- type: dropdown
id: license
attributes:
label: License
description: License for your project
options:
- Apache License 2.0
- MIT license
- BSD 3-Clause "New" or "Revised" license
- BSD 2-Clause "Simplified" or "FreeBSD" license
- GNU General Public License (GPL)
- GNU Library or "Lesser" General Public License (LGPL)
- Mozilla Public License 2.0
- Common Development and Distribution License
- Eclipse Public License version 2.0
validations:
required: true
- type: textarea
id: affiliations
attributes:
label: Affiliations
description: Affiliations of the project.
placeholder: None
validations:
required: false
- type: dropdown
id: tags
attributes:
label: Tags
multiple: true
options:
- tool
- plugin
- tutorial
- paper-implementation
- fork
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!--
⚠️ If you do not respect this template, your pull request will be closed.
⚠️ Your pull request title should be short detailed and understandable for all.
⚠️ Also, please add a release note file using reno if the change needs to be
documented in the release notes.
⚠️ If your pull request fixes an open issue, please link to the issue.

- [ ] I have added the tests to cover my changes.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the CONTRIBUTING document.
-->

### Summary



### Details and comments
45 changes: 45 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Tests

on: [push]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.9
uses: actions/setup-python@v2
with:
python-version: '3.9'
- name: Install tox
run: |
python -m pip install --upgrade pip
pip install tox
- name: Run styles check
run: tox -elint
tests:
runs-on: ubuntu-latest
strategy:
max-parallel: 4
matrix:
python-version: [3.9]
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python-version }}
- name: Set up tox env
run: |
pver=${{ matrix.python-version }}
tox_env="-epy${pver/./}"
echo tox_env
echo TOX_ENV=$tox_env >> $GITHUB_ENV
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r requirements-dev.txt
- name: Test using tox envs
run: |
tox ${{ env.TOX_ENV }}
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,4 @@ dmypy.json
# Pyre type checker
.pyre/

.idea/
.idea/
Loading

0 comments on commit 50a6698

Please sign in to comment.