Skip to content

Commit 706d7c6

Browse files
whonionwhonion
committed
Initial commit
0 parents  commit 706d7c6

File tree

14 files changed

+404
-0
lines changed

14 files changed

+404
-0
lines changed

‎.gitattributes‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto
3+
* linguist-language=md
4+
*.md linguist-detectable=true

‎.github/CONTRIBUTING.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Contributing
2+
3+
## Request for changes/ Pull Requests
4+
You first need to create a fork of the [github-issue-template](https://github.com/whonion/all-project-template/) repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
5+
6+
Then add your fork as a local project:
7+
8+
```sh
9+
# Using HTTPS
10+
git clone https://github.com/whonion/all-project-template.git
11+
12+
# Using SSH
13+
git clone git@github.com:whonion/all-project-template.git
14+
```
15+
16+
> [Which remote URL should be used ?](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories)
17+
18+
Then, go to your local folder
19+
20+
```sh
21+
cd github-issue-template
22+
```
23+
24+
Add git remote controls :
25+
26+
```sh
27+
# Using HTTPS
28+
git remote add fork https://github.com/YOUR-USERNAME/all-project-template.git
29+
git remote add upstream https://github.com/whonion/all-project-template.git
30+
31+
32+
# Using SSH
33+
git remote add fork git@github.com:YOUR-USERNAME/all-project-template.git
34+
git remote add upstream git@github.com/whonion/all-project-template.git
35+
```
36+
37+
You can now verify that you have your two git remotes:
38+
39+
```sh
40+
git remote -v
41+
```
42+
43+
## Receive remote updates
44+
In view of staying up to date with the central repository :
45+
46+
```sh
47+
git pull upstream main
48+
```
49+
50+
## Choose a base branch
51+
Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use main.
52+
53+
| Type of change | | Branches |
54+
| :------------------ |:---------:| ---------------------:|
55+
| Documentation | | `main` |
56+
| Bug fixes | | `main` |
57+
| New features | | `main` |
58+
| New issues models | | `YOUR-USERNAME:patch` |
59+
60+
```sh
61+
# Switch to the desired branch
62+
git switch main
63+
64+
# Pull down any upstream changes
65+
git pull
66+
67+
# Create a new branch to work on
68+
git switch --create patch/1234-name-issue
69+
```
70+
71+
Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the all-project-template repository](https://github.com/whonion/all-project-template/) following the template provided.

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: "🐛 Bug Report"
2+
description: Create a new ticket for a bug.
3+
title: "🐛 [BUG] - <title>"
4+
labels: [
5+
"bug"
6+
]
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: "Description"
12+
description: Please enter an explicit description of your issue
13+
placeholder: Short and explicit description of your incident...
14+
validations:
15+
required: true
16+
- type: input
17+
id: reprod-url
18+
attributes:
19+
label: "Reproduction URL"
20+
description: Please enter your GitHub URL to provide a reproduction of the issue
21+
placeholder: ex. https://github.com/USERNAME/REPO-NAME
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: reprod
26+
attributes:
27+
label: "Reproduction steps"
28+
description: Please enter an explicit description of your issue
29+
value: |
30+
1. Go to '...'
31+
2. Click on '....'
32+
3. Scroll down to '....'
33+
4. See error
34+
render: bash
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: screenshot
39+
attributes:
40+
label: "Screenshots"
41+
description: If applicable, add screenshots to help explain your problem.
42+
value: |
43+
![DESCRIPTION](LINK.png)
44+
render: bash
45+
validations:
46+
required: false
47+
- type: textarea
48+
id: logs
49+
attributes:
50+
label: "Logs"
51+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
52+
render: bash
53+
validations:
54+
required: false
55+
- type: dropdown
56+
id: browsers
57+
attributes:
58+
label: "Browsers"
59+
description: What browsers are you seeing the problem on ?
60+
multiple: true
61+
options:
62+
- Firefox
63+
- Chrome
64+
- Safari
65+
- Microsoft Edge
66+
- Opera
67+
validations:
68+
required: false
69+
- type: dropdown
70+
id: os
71+
attributes:
72+
label: "OS"
73+
description: What is the impacted environment ?
74+
multiple: true
75+
options:
76+
- Windows
77+
- Linux
78+
- Mac
79+
validations:
80+
required: false

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: "💡 Feature Request"
2+
description: Create a new ticket for a new feature request
3+
title: "💡 [REQUEST] - <title>"
4+
labels: [
5+
"question"
6+
]
7+
body:
8+
- type: input
9+
id: start_date
10+
attributes:
11+
label: "Start Date"
12+
description: Start of development
13+
placeholder: "month/day/year"
14+
validations:
15+
required: false
16+
- type: textarea
17+
id: implementation_pr
18+
attributes:
19+
label: "Implementation PR"
20+
description: Pull request used
21+
placeholder: "#Pull Request ID"
22+
validations:
23+
required: false
24+
- type: textarea
25+
id: reference_issues
26+
attributes:
27+
label: "Reference Issues"
28+
description: Common issues
29+
placeholder: "#Issues IDs"
30+
validations:
31+
required: false
32+
- type: textarea
33+
id: summary
34+
attributes:
35+
label: "Summary"
36+
description: Provide a brief explanation of the feature
37+
placeholder: Describe in a few lines your feature request
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: basic_example
42+
attributes:
43+
label: "Basic Example"
44+
description: Indicate here some basic examples of your feature.
45+
placeholder: A few specific words about your feature request.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: drawbacks
50+
attributes:
51+
label: "Drawbacks"
52+
description: What are the drawbacks/impacts of your feature request ?
53+
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: unresolved_question
58+
attributes:
59+
label: "Unresolved questions"
60+
description: What questions still remain unresolved ?
61+
placeholder: Identify any unresolved issues.
62+
validations:
63+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## PR Type
2+
What kind of change does this PR introduce?
3+
```
4+
[ ] Bugfix
5+
[ ] Feature
6+
[ ] Code style update (formatting, local variables)
7+
[ ] Refactoring (no functional changes, no api changes)
8+
[ ] Build related changes
9+
[ ] CI related changes
10+
[ ] Documentation content changes
11+
[ ] Tests
12+
[ ] Other
13+
```
14+
## What's new?
15+
-
16+
17+
## Screenshots
18+
N/A

‎.github/dependabot.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
open-pull-requests-limit: 10
8+
9+
- package-ecosystem: "gitsubmodule"
10+
directory: "/"
11+
schedule:
12+
interval: "weekly"

‎.github/workflows/build.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: Build
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout repository
10+
uses: actions/checkout@v4

‎.vscode/settings.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"CodeGPT.apiKey": "CodeGPT Plus Beta"
3+
}

‎CODE_OF_CONDUCT.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project,
4+
and in the interest of fostering an open and welcoming community,
5+
we pledge to respect all people who contribute through reporting issues,
6+
posting feature requests, updating documentation,
7+
submitting pull requests or patches, and other activities.
8+
9+
We are committed to making participation in this project
10+
a harassment-free experience for everyone,
11+
regardless of level of experience, gender, gender identity and expression,
12+
sexual orientation, disability, personal appearance,
13+
body size, race, ethnicity, age, religion, or nationality.
14+
15+
Examples of unacceptable behavior by participants include:
16+
17+
* The use of sexualized language or imagery
18+
* Personal attacks
19+
* Trolling or insulting/derogatory comments
20+
* Public or private harassment
21+
* Publishing other's private information,
22+
such as physical or electronic
23+
addresses, without explicit permission
24+
* Other unethical or unprofessional conduct.
25+
26+
Project maintainers have the right and responsibility to remove, edit, or reject
27+
comments, commits, code, wiki edits, issues, and other contributions
28+
that are not aligned to this Code of Conduct.
29+
By adopting this Code of Conduct,
30+
project maintainers commit themselves to fairly and consistently
31+
applying these principles to every aspect of managing this project.
32+
Project maintainers who do not follow or enforce the Code of Conduct
33+
may be permanently removed from the project team.
34+
35+
This code of conduct applies both within project spaces and in public spaces
36+
when an individual is representing the project or its community.
37+
38+
Instances of abusive, harassing, or otherwise unacceptable behavior
39+
may be reported by opening an issue
40+
or contacting one or more of the project maintainers.
41+
42+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
43+
available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

0 commit comments

Comments
 (0)