Skip to content

Commit 3b38bfd

Browse files
WoolfreyWoolfrey
authored
Merging devel in to master
I approve of my own changes.
2 parents f974ce6 + 27adf60 commit 3b38bfd

File tree

5 files changed

+186
-6
lines changed

5 files changed

+186
-6
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: 🐞 Bug Report
2+
description: Report a problem.
3+
title: "[BUG] <short description>"
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a bug!
10+
- type: input
11+
id: os
12+
attributes:
13+
label: What operating system are you using?
14+
placeholder: e.g. Ubuntu 22.04
15+
validations:
16+
required: true
17+
- type: input
18+
id: ros
19+
attributes:
20+
label: What version of Eigen are you using?
21+
placeholder: e.g. v3.4
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: what
26+
attributes:
27+
label: What happened?
28+
description: List the sequence of events that led to the problem.
29+
placeholder: |
30+
1. The Big Bang happened, then
31+
2. I was born.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: why
36+
attributes:
37+
label: What might be causing the problem?
38+
description: Provide information on why it might be happening.
39+
placeholder: I asked ChatGPT and this is what it said.
40+
validations:
41+
required: false
42+
- type: textarea
43+
id: evidence
44+
attributes:
45+
label: Supporting Evidence
46+
description: Provide screenshots, compilation or runtime errors, etc.
47+
placeholder: (┛ಠДಠ)┛彡┻━┻
48+
validations:
49+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
############################################################
2+
# Required Fields #
3+
############################################################
4+
name: ✨ Feature Request
5+
description: Suggest a new feature or enhancement.
6+
7+
############################################################
8+
# Optional Fields #
9+
############################################################
10+
assignees: []
11+
labels: [enhancement]
12+
projects: []
13+
title: "[REQUEST] <Short description>"
14+
15+
############################################################
16+
# Layout #
17+
############################################################
18+
body:
19+
- type: markdown
20+
attributes:
21+
value: |
22+
Ideas are always weclome!
23+
24+
- type: dropdown
25+
id: priority
26+
attributes:
27+
label: Priority
28+
description: How important is this feature to you?
29+
options:
30+
- Nice to have
31+
- Important
32+
- Blocking my work
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: feature
38+
attributes:
39+
label: What would you like to see?
40+
description: A concise description, with pictures if possible.
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: benefit
46+
attributes:
47+
label: What is the immediate benefit?
48+
description: How this feature will be useful.
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: implication
54+
attributes:
55+
label: What implications will it have?
56+
description: The long-term benefit or impact.
57+
validations:
58+
required: false

‎.github/ISSUE_TEMPLATE/open_task.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
############################################################
2+
# Required Fields #
3+
############################################################
4+
name: 🙋 Open Task
5+
description: This template is intended for internal use only.
6+
7+
############################################################
8+
# Optional Fields #
9+
############################################################
10+
assignees: []
11+
labels: [enhancement]
12+
projects: []
13+
title: "🙋 [OPEN] This template is intended for internal use only."
14+
15+
############################################################
16+
# Layout #
17+
############################################################
18+
body:
19+
- type: markdown
20+
attributes:
21+
value: |
22+
Open tasks that the public can contribute to.
23+
24+
- type: dropdown
25+
id: priority
26+
attributes:
27+
label: What is the priority?
28+
options:
29+
- Low (Nice to have, but not critical).
30+
- Medium (Useful, but can live without it).
31+
- High (I would do this myself, but don't have time).
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: feature
37+
attributes:
38+
label: What would we like to have?
39+
description: A concise description, with pictures if possible.
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: benefit
45+
attributes:
46+
label: What is the immediate benefit?
47+
description: How this feature will be useful.
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: implication
53+
attributes:
54+
label: What implications will it have?
55+
description: The long-term benefit or impact.
56+
validations:
57+
required: false

‎CITATION.cff‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ authors:
44
- family-names: "Woolfrey"
55
given-names: "Jon"
66
orcid: "https://orcid.org/0000-0001-5926-5669"
7-
title: "SimpleQPSolver"
7+
title: "Simple QP Solver"
88
version: 1.0.0
99
date-released: 2023-08-10
10-
url: "https://github.com/Woolfrey/SimpleQPSolver"
10+
url: "https://github.com/Woolfrey/software_simple_qp"

‎README.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ There are also several functions for handling linear least squares problems with
3434
- [Optimisation with Inequality Constraints](#optimisation-with-inequality-constraints)
3535
- [Options for the Interior Point Algorithm](#options-for-the-interior-point-algorithm)
3636
- [Running the Test File](#running-the-test-file)
37+
- [Contributing](#handshake-contributing)
3738
- [Citing this Repository](#bookmark_tabs-citing-this-repository)
39+
- [License](#scroll-license)
3840

3941
## :floppy_disk: Installation Instructions
4042

@@ -248,11 +250,22 @@ which prints information about the use of different class methods, as well as th
248250

249251
[:top: Back to top.](#cyclone-simple-qp-solver)
250252

253+
## :handshake: Contributing
254+
255+
Contributions to this project are always welcome! Feel free to:
256+
1. Fork the repository,
257+
2. Implement your changes, then
258+
3. Submit a pull request.
259+
260+
If you're looking for ideas, you can always check the [Issues tab](https://github.com/Woolfrey/software_simple_qp/issues) for those with :raising_hand: [OPEN]. These are things I'd like to implement myself, but don't have time. It'd be much appreciated, and you'll be listed as a contributor!
261+
251262
## :bookmark_tabs: Citing this Repository
252263

253-
If you use `SimpleQPSolver` and find it useful, I'd appreciate it if you could cite me. Here is a `BibTeX` format:
264+
If you use `SimpleQPSolver` and find it useful, I'd appreciate it if you could cite me. Click on `Cite this repository` under the **About** section at the top-right corner of this page :arrow_upper_right:
265+
266+
Here is the `BibTeX` reference:
254267
```
255-
@software{Woolfrey_SimpleQPSolver_2023,
268+
@software{woolfrey_simple_qp_2023,
256269
author = {Woolfrey, Jon},
257270
month = aug,
258271
title = {{S}imple {QP} {S}olver},
@@ -263,10 +276,13 @@ If you use `SimpleQPSolver` and find it useful, I'd appreciate it if you could c
263276
```
264277
Here's the automatically generated APA format:
265278
```
266-
Woolfrey, J. (2023). SimpleQPSolver (Version 1.0.0) [Computer software]. https://github.com/Woolfrey/software_simple_qp
279+
Woolfrey, J. (2023). Simple QP Solver (Version 1.0.0) [Computer software]. https://github.com/Woolfrey/software_simple_qp
267280
```
268-
Alternatively, click on `Cite this repository` on the top-right corner of this page.
269281

270282
[:top: Back to top.](#cyclone-simple-qp-solver)
271283

284+
## :scroll: License
285+
286+
This software package is licensed under the [GNU General Public License v3.0 (GPL-3.0)](https://choosealicense.com/licenses/gpl-3.0/). You are free to use, modify, and distribute this package, provided that any modified versions also comply with the GPL-3.0 license. All modified versions must make the source code available and be licensed under GPL-3.0. The license also ensures that the software remains free and prohibits the use of proprietary restrictions such as Digital Rights Management (DRM) and patent claims. For more details, please refer to the [full license text](LICENSE).
272287

288+
[:top: Back to top.](#cyclone-simple-qp-solver)

0 commit comments

Comments
 (0)