-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Bryn Pickering <17178478+brynpickering@users.noreply.github.com>
- Loading branch information
1 parent
bbd303e
commit c6a0e6a
Showing
156 changed files
with
3,970 additions
and
100,168 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| name: Bug Report | ||
| description: Report a bug that leads to Calliope not working as expected. | ||
| labels: [bug] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
| - type: textarea | ||
| id: what-happened | ||
| attributes: | ||
| label: What happened? | ||
| description: Also tell us what you expected to happen. | ||
| placeholder: Tell us what you see! | ||
| value: "Something unexpected happened!" | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: operating-systems | ||
| attributes: | ||
| label: Which operating systems have you used? | ||
| description: You may select more than one. | ||
| options: | ||
| - label: macOS | ||
| - label: Windows | ||
| - label: Linux | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: version | ||
| attributes: | ||
| label: Version | ||
| description: What version of Calliope are you using? | ||
| placeholder: v0.1.0 | ||
| - 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 | ||
| validations: | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| name: Report a documentation issue | ||
| description: Missing, incorrect, or confusing information in our docs? Report a documentation issue | ||
| labels: | ||
| - documentation | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: >- | ||
| Please describe the inconsistency or issue you have found in | ||
| [our documentation](https://calliope.readthedocs.io) | ||
| or indicate where you feel there is a need for improvement. Furthermore, | ||
| explain the severity of the issue, i.e., its impact on you and potentially | ||
| other users. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: related-links | ||
| attributes: | ||
| label: Related links | ||
| description: >- | ||
| Please list all links to the sections of [our documentation](https://calliope.readthedocs.io) | ||
| that are impacted by the issue you described above. If applicable, | ||
| add screenshots. Additionally, list links to possibly related open | ||
| and closed [issues](https://github.com/calliope-project/calliope/issues) | ||
| and [discussions](https://github.com/calliope-project/calliope/discussions) | ||
| you encountered when searching our issue tracker. | ||
| value: | | ||
| - | ||
| - | ||
| ... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: version | ||
| attributes: | ||
| label: Version | ||
| description: Which version of the documentation are you referring to? | ||
| placeholder: v0.7.0 | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: proposed-change | ||
| attributes: | ||
| label: Proposed change | ||
| description: >- | ||
| This field is optional. You may provide an improvement proposal for our | ||
| documentation by describing your suggestion in the text field below or | ||
| creating a pull request after reporting this issue referencing the issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| name: Feature Request | ||
| description: Suggest an idea for Calliope. | ||
| labels: [enhancement] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for letting us know about your idea! | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: What can be improved? | ||
| placeholder: Tell us what you would like to see! | ||
| value: "Calliope should be more memory efficient!" | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: version | ||
| attributes: | ||
| label: Version | ||
| description: What version of Calliope are you using? | ||
| placeholder: v0.1.0 | ||
| validations: | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| blank_issues_enabled: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,3 @@ | ||
| # How to contribute | ||
|
|
||
| We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. | ||
|
|
||
| Some of the resources to look at if you're interested in contributing: | ||
|
|
||
| * [Join us on Gitter to chat!](https://app.gitter.im/#/room/#calliope-project_calliope:gitter.im) | ||
| * Look at our [milestones](https://github.com/calliope-project/calliope/milestones) and [projects](https://github.com/calliope-project/calliope/projects) on GitHub for an idea on where development is headed | ||
| * Look at [open issues tagged with "help wanted"](https://github.com/calliope-project/calliope/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and ["good first issue"](https://github.com/calliope-project/calliope/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) | ||
| * Look at the [development guide in our documentation](http://calliope.readthedocs.io/en/stable/user/develop.html) | ||
|
|
||
| ## Licensing | ||
|
|
||
| By contributing to Calliope, e.g. through opening a pull request or submitting a patch, you represent that your contributions are your own original work and that you have the right to license them, and you agree that your contributions are licensed under the Apache 2.0 license. | ||
|
|
||
| ## Submitting bug reports | ||
|
|
||
| [Open an issue on GitHub](https://github.com/calliope-project/calliope/issues/new) to report bugs or other problems. | ||
|
|
||
| If reporting an error when running Calliope on the command line, please re-run your command with the ``--debug`` option, e.g.: | ||
|
|
||
| ``calliope run my_model.yaml --debug`` | ||
|
|
||
| Then post the full output from the debug run as part of your GitHub issues. | ||
|
|
||
| If reporting an error when running Calliope interactively in a Python session, please include a full traceback in your issue. | ||
|
|
||
| ## Submitting changes | ||
|
|
||
| Look at the [development guide in our documentation](http://calliope.readthedocs.io/en/stable/user/develop.html) for information on how to get set up for development. | ||
|
|
||
| To contribute changes: | ||
|
|
||
| 1. Fork the project on GitHub | ||
| 2. Create a feature branch to work on in your fork (``git checkout -b new-fix-or-feature``) | ||
| 3. Add your name to the ``AUTHORS`` file | ||
| 4. Commit your changes to the feature branch after running black to format your code (formatting is automatic if the ``pre-commit`` hooks have been installed; see [below](#coding-conventions) for more info) | ||
| 5. Push the branch to GitHub (``git push origin new-fix-or-feature``) | ||
| 6. On GitHub, create a new [pull request](https://github.com/calliope-project/calliope/pull/new/main) from the feature branch | ||
|
|
||
| Our [development guide](http://calliope.readthedocs.io/en/stable/user/develop.html) gives a more detailed description of each step, if you're new to working with GitHub. | ||
|
|
||
| ### Pull requests | ||
|
|
||
| Before submitting a pull request, check whether you have: | ||
|
|
||
| * Added your changes to ``changelog.rst`` | ||
| * Added or updated documentation for your changes | ||
| * Added tests if you implemented new functionality | ||
|
|
||
| When opening a pull request, please provide a clear summary of your changes! | ||
|
|
||
| ### Commit messages | ||
|
|
||
| Please try to write clear commit messages. One-line messages are fine for small changes, but bigger changes should look like this: | ||
|
|
||
| A brief summary of the commit | ||
|
|
||
| A paragraph or bullet-point list describing what changed and its impact, | ||
| covering as many lines as needed. | ||
|
|
||
| ## Testing | ||
|
|
||
| We have existing test coverage for the key functionality of Calliope. | ||
|
|
||
| All tests are in the ``tests`` directory and use [pytest](https://docs.pytest.org/en/latest/). | ||
|
|
||
| Our test coverage is not perfect and an easy way to contribute code is to work on better tests. | ||
|
|
||
| ## Coding conventions | ||
|
|
||
| Start reading our code and you'll get the hang of it. | ||
|
|
||
| We mostly follow the official [Style Guide for Python Code (PEP8)](https://www.python.org/dev/peps/pep-0008/). | ||
|
|
||
| We have chosen to use the uncompromising code formatter, [`black`](https://github.com/psf/black/). If run from the root directory of this repo, `pyproject.toml` should ensure the line lengths are restricted to 88. The philosophy behind using black is to have uniform style throughout the project dictated by code. Since `black` is designed to minimise diffs, and make patches more human readable, this also makes code reviews more efficient. To make this a smooth experience, you should add a black formatting script to your git pre-commit hooks before creating a PR. We provide a quick and easy way to set this up as part of the [development guide in our documentation](http://calliope.readthedocs.io/en/stable/user/develop.html#installing-a-development-version). | ||
|
|
||
| ## Attribution | ||
|
|
||
| The layout and content of this document is partially based on the [OpenGovernment project's contribution guidelines](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md). | ||
| Please see our [guide for contributing](https://calliope.readthedocs.io/en/latest/contributing/) in the documentation! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.