Skip to content

Commit 282907f

Browse files
AngryMaciekAngryMaciek
authored
refactor: improve overall repo structure (#61)
1 parent 61ddc88 commit 282907f

24 files changed

Lines changed: 401 additions & 128 deletions

‎.gitattributes‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Normalise line endings automatically for files detected as text by default.
2+
# That is: let the git installation on a user's machine decide
3+
# which line ending to use when a repository is checked out.
4+
# Subsequent lines may override this setting.
5+
* text=auto
6+
7+
# recognise file syntax during diff
8+
*.hpp text diff=cpp
9+
*.cpp text diff=cpp
10+
*.tex text diff=tex
11+
*.bib text diff=bibtex
12+
*.md text diff=markdown
13+
*.sh text diff=bash
14+
15+
# force batch scripts to always use CRLF
16+
*.cmd text eol=crlf
17+
*.bat text eol=crlf
18+
19+
# force bash scripts & Makefile to always use LF
20+
*.sh text eol=lf
21+
Makefile text eol=lf
22+
23+
# mark binary files explicitly
24+
# (Git does not try to merge these files)
25+
# binary is a built-in macro attribute == -diff -merge -text
26+
*.png binary
27+
28+
# specify which files/dirs to ignore on [download ZIP] (not a git repo)
29+
.github export-ignore
30+
.test export-ignore
31+
.docs export-ignore
32+
img export-ignore
33+
.gitattributes export-ignore
34+
.gitignore export-ignore
35+
.gitpod.dockerfile export-ignore
36+
.gitpod.yml export-ignore
37+
.pre-commit-config.yaml export-ignore
38+
CODE_OF_CONDUCT.md export-ignore
39+
codecov.yml export-ignore
40+
CODEOWNERS export-ignore
41+
CONTRIBUTING.md export-ignore
42+
Doxyfile export-ignore
43+
environment.yml export-ignore
44+
meta.yaml export-ignore
45+
paper.bib export-ignore
46+
paper.md export-ignore
47+
48+
# linguist settings:
49+
#
50+
# Gitpod configuration files
51+
.gitpod.dockerfile -linguist-detectable
52+
.gitpod.yml -linguist-detectable
53+
# Dev Docker/env
54+
Dockerfile -linguist-detectable
55+
entrypoint.sh -linguist-detectable
56+
environment.yml -linguist-detectable
57+
# Catch2 test framework
58+
.test/unit/catch.hpp -linguist-detectable

‎.github/ISSUE_TEMPLATE/BLANK_TEMPLATE.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: "Blank Template 💬"
3+
about: Empty template for special occasions only
4+
labels:
5+
---

‎.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Bug Report 🐛
2+
description: Create a bug report
3+
title: "<descriptive title goes here>"
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for your interest in this project!
10+
11+
Please read the following instructions carefully.
12+
Having detailed, yet not overcomplicated feedback will help us resolve the issue efficiently 🚀
13+
14+
**Before reporting a bug, please search for a similar problem in the issues section**
15+
- type: checkboxes
16+
id: checks
17+
attributes:
18+
label: Initial check.
19+
description: Please go through the options carefully.
20+
options:
21+
- label: I added a very descriptive title above.
22+
required: true
23+
- label: I searched through the issues in this repository to find a similar problem, but didn't find any.
24+
required: true
25+
- label: I searched the documentation and found no explanation.
26+
required: true
27+
- label: I searched through Google (including the 2nd page of results) and didn't find any relevant information.
28+
required: true
29+
- label: I asked ChatGPT for help but did not get any meaningful response.
30+
required: false
31+
- type: textarea
32+
id: description
33+
attributes:
34+
label: Please describe what triggered the error.
35+
description: Add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
36+
placeholder: If you can copy it, run it, and see it right away, there's a much higher chance someone will be able to help you.
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: expected
41+
attributes:
42+
label: What did you expect to happen?
43+
description: How should the program behave without the bug?
44+
placeholder: Describe the ideal outcome.
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: error
49+
attributes:
50+
label: What went wrong?
51+
description: What kind of error message did you get?
52+
placeholder: You should add terminal logs.
53+
validations:
54+
required: true
55+
- type: input
56+
id: gpp_version
57+
attributes:
58+
label: Please specify your compiler's version.
59+
placeholder: g++ --version
60+
validations:
61+
required: true
62+
- type: dropdown
63+
id: os_version
64+
attributes:
65+
label: Operating System
66+
options:
67+
- Linux
68+
- macOS
69+
- Microsoft Windows
70+
- Other
71+
validations:
72+
required: true
73+
- type: checkboxes
74+
id: terms
75+
attributes:
76+
label: Code of Conduct
77+
options:
78+
- label: I agree to follow this project's [Code of Conduct](https://github.com/AngryMaciek/hypercomplex/blob/master/CODE_OF_CONDUCT.md)
79+
required: true
80+
- type: textarea
81+
id: context
82+
attributes:
83+
label: Additional information
84+
description: Add any additional context or screenshots you think might be useful or helpful.
85+
validations:
86+
required: false
87+
- type: markdown
88+
attributes:
89+
value: |
90+
91+
92+
*Thank you for your contribution!*

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Feature Request 💡
2+
description: Suggest an idea for improvement
3+
title: "<descriptive title goes here>"
4+
labels:
5+
- enhancement
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for your interest in this project!
11+
12+
Please read the following instructions carefully.
13+
Having detailed, yet not overcomplicated feedback will help us implement the idea efficiently 🚀
14+
15+
**Before suggesting an idea, please search for a similar feature request in the issues section**
16+
- type: checkboxes
17+
id: checks
18+
attributes:
19+
label: Initial check.
20+
description: Please go through the options carefully.
21+
options:
22+
- label: I added a very descriptive title above.
23+
required: true
24+
- label: I searched the documentation and found no similar feature.
25+
required: true
26+
- label: I searched through the issues in this repository to find a similar request, but didn't find any.
27+
required: true
28+
- type: textarea
29+
id: description
30+
attributes:
31+
label: Describe briefly the idea behind the improvement.
32+
description: When would it be useful? What problem would it solve?
33+
placeholder: Try to come up with a use case
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: ideas
38+
attributes:
39+
label: Please specify what would you like to add/change.
40+
description: How would you make your idea come true?
41+
placeholder: You may inclue code snippets
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: alternatives
46+
attributes:
47+
label: Please add other solutions if you considered them.
48+
description: Alternative ways to bring your idea to life.
49+
placeholder: First thought best thought?
50+
validations:
51+
required: false
52+
- type: textarea
53+
id: supplement
54+
attributes:
55+
label: Feel free to provide additional information or more context for your idea.
56+
description: Screenshots or other information you find worth sharing; anything the developers might find useful.
57+
placeholder:
58+
validations:
59+
required: false
60+
- type: checkboxes
61+
id: terms
62+
attributes:
63+
label: Code of Conduct
64+
description: By submitting this feature request, you agree to follow our Code of Conduct.
65+
options:
66+
- label: I agree to follow this project's [Code of Conduct](https://github.com/AngryMaciek/hypercomplex/blob/master/CODE_OF_CONDUCT.md)
67+
required: true
68+
- type: markdown
69+
attributes:
70+
value: |
71+
*Keep the ideas coming!*

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security or Code of Conduct violation
4+
about: Please report security or behaviour issues to wsciekly.maciek@gmail.com

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Proposed changes ⤴️
2+
3+
Describe the big picture of your changes, add relevant motivation and context.
4+
5+
**If it fixes a bug or resolves a feature request, please link a corresponding issue:**
6+
Fixes #
7+
8+
## Types of changes 🔧
9+
10+
What type of changes does your code introduce to the project?
11+
12+
- [ ] Bugfix (non-breaking change which fixes an issue)
13+
- [ ] New feature (non-breaking change which adds functionality)
14+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
15+
- [ ] Other
16+
17+
## Checklist ✅
18+
19+
If you're unsure about any of those below, ask explicitly.
20+
This is simply a reminder of what needs to be checked before merging your code.
21+
22+
- [ ] I have read the [CONTRIBUTING](https://github.com/AngryMaciek/hypercomplex/blob/master/CONTRIBUTING.md).
23+
- [ ] I have performed a self-review of my own code.
24+
- [ ] Tests specified with the 'make' framework do not raise any errors.
25+
- [ ] I have added tests that prove my fix is effective or that my feature works.
26+
- [ ] I have added necessary documentation (if appropriate).
27+
- [ ] My changes generate no new warnings.
28+
- [ ] I have commented my code, particularly in hard-to-understand areas.
29+
30+
## Further comments 🧠
31+
32+
If this is a relatively large or complex change feel free to provide additional information or explanation.

0 commit comments

Comments
 (0)