Skip to content

Commit

Permalink
Apply BestieTemplate 0.12.0 and update minimum Julia version to 1.10
Browse files Browse the repository at this point in the history
Closes #676
  • Loading branch information
abelsiqueira committed Oct 9, 2024
1 parent df5029e commit c8ad97d
Show file tree
Hide file tree
Showing 61 changed files with 1,184 additions and 876 deletions.
5 changes: 5 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"projectName": "TulipaEnergyModel",
"projectOwner": "TulipaEnergy",
"files": ["README.md", "docs/src/index.md"]
}
16 changes: 16 additions & 0 deletions .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Changes here will be overwritten by Copier
AnswerStrategy: recommended
Authors: Diego A. Tejada-Arango <[email protected]>,Germán Morales-España
<[email protected]>,Lauren Clisby <[email protected]>,Ni Wang <[email protected]>,Abel
Soares Siqueira <[email protected]>,Suvayu Ali <[email protected]>,Laurent
Soucasse <[email protected]>,Greg Neustroev <[email protected]>
JuliaIndentation: 4
JuliaMinVersion: '1.10'
License: Apache-2.0
LicenseCopyrightHolders: Diego A. Tejada-Arango, Germán Morales-España, Lauren Clisby,
Ni Wang, Abel Soares Siqueira, Suvayu Ali, Laurent Soucasse, Greg Neustroev
PackageName: TulipaEnergyModel
PackageOwner: TulipaEnergy
PackageUUID: 5d7bd171-d18e-45a5-9111-f1f11ac5d04d
_commit: v0.12.0
_src_path: https://github.com/JuliaBesties/BestieTemplate.jl
10 changes: 9 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ root = true
end_of_line = lf
insert_final_newline = true
charset = utf-8
indent_size = 4
indent_style = space
trim_trailing_whitespace = true

[*.jl]
indent_size = 4

[*.md]
indent_size = 2

[*.{yml,toml,json}]
indent_size = 2
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/10-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug Report
description: File a bug report related to running the package
title: "[Bug] "
labels: ["Type: bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please, before submitting, make sure that:
- There is not an [existing issue](https://github.com/TulipaEnergy/TulipaEnergyModel.jl/issues) with the same question
- You have read the [contributing guide](https://TulipaEnergy.github.io/TulipaEnergyModel.jl/dev/90-contributing/)
The form below should help you in filling out this issue.
- type: textarea
id: description
attributes:
label: Description
description: Describe the bug
validations:
required: true
- type: input
id: pkg-version
attributes:
label: Package Version
description: What version of the package are you running?
placeholder: In Julia, press ] to enter pkg mode, and then run `pkg> status`
validations:
required: true
- type: input
id: version
attributes:
label: Julia Version
description: What version of Julia are you running?
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction steps
description: What steps led to the bug happening? Please provide a minimal reproducible example.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: dropdown
id: os
attributes:
label: "Operating System"
description: What is the impacted environment?
multiple: true
options:
- Windows
- Linux
- Mac
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/20-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: "Feature Request"
description: Suggest a new feature for the package
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
Please, before submitting, make sure that:
- There is not an [existing issue](https://github.com/TulipaEnergy/TulipaEnergyModel.jl/issues) with the same question
- You have read the [contributing guide](https://TulipaEnergy.github.io/TulipaEnergyModel.jl/dev/90-contributing/)
The form below should help you in filling out this issue.
- type: textarea
id: description
attributes:
label: Description
description: Describe the requested feature
validations:
required: true
- type: textarea
id: validation
attributes:
label: Validation and testing
description: How could we verify that the new feature works? What kind of tests can be done?
- type: textarea
id: motivation
attributes:
label: Motivation
description: Explain why this feature is relevant
- type: textarea
id: target
attributes:
label: Target audience
description: Tell more about the users of this feature, or where it could be useful
- type: textarea
id: can-help
attributes:
label: Can you help?
description: Can you help developing this feature?
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/30-usage.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: "Usage question"
description: Questions related to the usage
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this question!
Please, before submitting, make sure that:
- You have checked the [documentation](https://TulipaEnergy.github.io/TulipaEnergyModel.jl) and haven't found enough information
- There is not an [existing issue](https://github.com/TulipaEnergy/TulipaEnergyModel.jl/issues) with the same question
- You have read the [contributing guide](https://TulipaEnergy.github.io/TulipaEnergyModel.jl/dev/90-contributing/)
The form below should help you in filling out this issue.
- type: textarea
id: description
attributes:
label: Description
description: Write your question
validations:
required: true
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/40-epic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: "Epic issue"
description: Create a new Epic issue to collect smaller issues that are part of a larger feature or goal.
labels: ["Type: epic"]
body:
- type: textarea
id: description
attributes:
label: "Description"
description: Please enter an explicit description of the large feature or goal
validations:
required: true
- type: textarea
id: issues
attributes:
label: "Sub issues"
description: List all tasks that need to be accomplished and convert them to issues as you work on them
value: |
- [ ]
- [ ]
- [ ]
...
validations:
required: false
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/99-general.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: "Other issues"
description: In case none of the others templates apply
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this issue!
Please, before submitting, make sure that:
- There is not an [existing issue](https://github.com/TulipaEnergy/TulipaEnergyModel.jl/issues) with the same question
- You have read the [contributing guide](https://TulipaEnergy.github.io/TulipaEnergyModel.jl/dev/90-contributing/)
The form below should help you in filling out this issue.
- type: textarea
id: description
attributes:
label: Description
description: Describe the issue
validations:
required: true
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/ADDITION-REQUEST.yml

This file was deleted.

46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml

This file was deleted.

25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/EPIC.yml

This file was deleted.

29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/IMPROVEMENT-REQUEST.yml

This file was deleted.

4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discussions
url: https://github.com/TulipaEnergy/TulipaEnergyModel.jl/discussions
about: Create and follow discussions here
35 changes: 24 additions & 11 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
# Pull request details
<!--
Thanks for making a pull request to TulipaEnergyModel.jl.
We have added this PR template to help you help us.
## Describe the changes made in this pull request
Make sure to read the contributing guidelines.
<!-- include screenshots if that helps the review -->
See the comments below, fill the required fields, and check the items.
-->

## List of related issues or pull requests
## Related issues

Closes #ISSUE_NUMBER
<!-- We normally work with (i) create issue; (ii) discussion if necessary; (iii) create PR. So, at least one of the following should be true:-->

## Collaboration confirmation
<!-- Option 1, this closes an existing issue. Fill the number below-->
Closes #

As a contributor I confirm
<!-- Option 2, this is a small fix that arguably won't need an issue. Uncomment below -->
<!--
There is no related issue.
-->

- [ ] I read and followed the instructions in README.dev.md
- [ ] The documentation is up to date with the changes introduced in this Pull Request (or NA)
- [ ] Tests are passing
- [ ] Lint is passing
## Checklist

<!-- mark true if NA -->
<!-- leave PR as draft until all is checked -->

- [ ] I am following the [contributing guidelines](https://github.com/TulipaEnergy/TulipaEnergyModel.jl/blob/main/docs/src/90-contributing.md)

- [ ] Tests are passing
- [ ] Lint workflow is passing
- [ ] Docs were updated and workflow is passing
Loading

0 comments on commit c8ad97d

Please sign in to comment.