Skip to content

Commit

Permalink
feat: Initial from scicookie 20240201155419 (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
xmnlab authored Feb 2, 2024
1 parent f3fb3e1 commit 3c49af3
Show file tree
Hide file tree
Showing 39 changed files with 4,742 additions and 96 deletions.
25 changes: 25 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# http://editorconfig.org

root = true

[*]
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
insert_final_newline = true
charset = utf-8
end_of_line = lf

[*.py]
indent_style = space
indent_size = 4

[*.bat]
indent_style = tab
end_of_line = crlf

[LICENSE]
insert_final_newline = true

[Makefile]
indent_style = tab
149 changes: 149 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
---
name: 🐛 Bug Report
description: Create a report to help us improve
labels: ["bug", "needs-triage"]

body:
- type: markdown
attributes:
value: >
**Thank you for wanting to report a bug in rXiv REST API!**
Verify first that your issue is not [already reported on
GitHub][issue search].
[issue search]: https://github.com/xmnlab/rxiv-restapi.git/issues?q=is%3Aopen+is%3Aissue+label%3Abug
- type: textarea
attributes:
label: Summary
description: Explain the problem briefly below.
placeholder: >-
When I try to do X with {{ cookiecutter.project_name }} and the following workspace, Y breaks or
Z happens in an unexpected manner.
Here are all the details I know about this problem.
validations:
required: true

- type: textarea
attributes:
label: OS / Environment
description: >-
Provide information on your operating system.
Something like the output of `cat /etc/os-release` on Linux or
`system_profiler -detailLevel mini SPSoftwareDataType` on macOS.
render: console
placeholder: |
# Linux
$ cat /etc/os-release
NAME="Ubuntu"
VERSION="20.04.2 LTS (Focal Fossa)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 20.04.2 LTS"
VERSION_ID="20.04"
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
VERSION_CODENAME=focal
UBUNTU_CODENAME=focal
# macOS
$ system_profiler -detailLevel mini SPSoftwareDataType | head -n 6
Software:
System Software Overview:
System Version: macOS 10.15.7 (19H1323)
Kernel Version: Darwin 19.6.0
validations:
required: true

- type: textarea
attributes:
label: Steps to Reproduce
description: >-
Describe exactly how to reproduce the problem, using a minimal test-case.
It would *really* help us understand your problem if you paste in the Python code
that you're running.
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
value: |
<!--- Paste your minimal failing Python example code between the quotes below -->
```python (paste below)
```
<!--- ...or if you have a failing CLI command paste it between the quotes below -->
```console (paste below)
```
validations:
required: true

- type: textarea
attributes:
label: File Upload (optional)
description: >-
If your steps to reproduce your minimal failing example require either a spec or a
workspace file, please upload it by attaching it to the text area here.
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
placeholder: >-
Attach any files or compressed archives by dragging & dropping, selecting,
or pasting them here.
validations:
required: false

- type: textarea
attributes:
label: Expected Results
description: >-
Describe what you expected to happen when running the steps above.
placeholder: >-
I expected X to happen because I assumed Y.
validations:
required: true

- type: textarea
attributes:
label: Actual Results
description: >-
Paste verbatim program or command output.
Don't wrap it with triple backticks &mdash; your whole input will be
turned into a code snippet automatically.
render: console
validations:
required: true

- type: textarea
attributes:
# label: rXiv REST API version
# description: >-
# Paste verbatim output from `rXiv REST API --version` below, under the prompt line.
# Don't wrap it with triple backticks &mdash; your whole input will be
# turned into a code snippet automatically.
render: console
placeholder: |
python -m pip show rXiv REST API
validations:
required: true

- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [`rXiv REST API` Code of Conduct][CoC] first.
[CoC]: https://github.com/xmnlab/rxiv-restapi.git/coc/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the Code of Conduct
required: true
...
This template has been adopted from [pyhf](https://github.com/scikit-hep/pyhf/tree/main/.github/ISSUE_TEMPLATE)'s excellent bug report template.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true
contact_links:
- name: 🙋 Usage Questions
url: https://github.com/xmnlab/rxiv-restapi.git/discussions
about: |
Use rXiv REST API's GitHub Discussions to ask "How do I do X with rXiv REST API?".
- name: 📖 Tutorial
url: https://github.com/xmnlab/rxiv-restapi.git
about: |
The rXiv REST API tutorial is continually updated and provides an in depth walkthrough
of how to use the latest release of rXiv REST API.
- name: 📝 rXiv REST API Code of Conduct
url: https://github.com/xmnlab/rxiv-restapi.git/coc/CODE_OF_CONDUCT.md
about: Expectations for how people will interact with each other on rXiv REST API's GitHub.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
name: 📝 Documentation Report
description: Create a report for problems with the docs
labels: ["docs", "needs-triage"]

body:
- type: markdown
attributes:
value: >
**Thank you for wanting to report a problem with rXiv REST API's documentation!**
Verify first that your issue is not [already reported on
GitHub][issue search].
[issue search]: https://github.com/xmnlab/rxiv-restapi.git/issues?q=is%3Aopen+is%3Aissue+label%3Adocs
- type: textarea
attributes:
label: Summary
description: >-
Explain the problem briefly below, add suggestions to wording or structure.
If there are external references that are related please link them here
as well.
placeholder: >-
I was reading the rXiv REST API documentation for rXiv REST API version X and I'm having
problems understanding Y.
It would be very helpful if that got rephrased as Z.
validations:
required: true

- type: input
attributes:
label: Documentation Page Link
description: |
Paste the link to the documentation webpage that you have a question on.
validations:
required: true

- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [`rXiv REST API` Code of Conduct][CoC] first.
[CoC]: https://github.com/xmnlab/rxiv-restapi.git/blob/main/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the Code of Conduct
required: true
...


This template has been adopted from [pyhf](https://github.com/scikit-hep/pyhf/tree/main/.github/ISSUE_TEMPLATE)'s excellent bug report template.
83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
name: ✨ Feature Request
description: Suggest an idea for this project
labels: ["feat/enhancement ", "needs-triage"]

body:
- type: markdown
attributes:
value: >
**Thank you for wanting to suggest a feature for rXiv REST API!**
Verify first that your issue is not [already reported on
GitHub][issue search].
Make sure to check the closed issues as well as it may
already be implemented in a development release.
[issue search]: https://github.com/xmnlab/rxiv-restapi.git/issues?q=is%3Aopen+is%3Aissue+label%3Afeat%2Fenhancement
- type: textarea
attributes:
label: Summary
description: >
Describe the new feature/improvement you would like briefly below.
What's the problem this feature will solve?
What are you trying to do, that you are unable to achieve
with the **latest** release of rXiv REST API?
* Provide examples of real-world use cases that this would enable
and how it solves the problem you described.
* How do you solve this now?
* Have you tried to work around the problem?
* Could there be a different approach to solving this issue?
If there are external references or other GitHub Issues that are related
please link them here as well.
placeholder: >-
I am trying to do X with rXiv REST API version x.y.z and I think that implementing
new feature Y would be very helpful for me and every other user because of Z.
validations:
required: true

- type: textarea
attributes:
label: Additional Information
description: |
If you can, describe how the feature would be used in a mock code example.
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
value: |
<!--- Describe what you are showing in your example -->
<!--- and then paste your mock Python example code between the quotes below -->
```python (paste below)
```
validations:
required: false

- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [`rXiv REST API` Code of Conduct][CoC] first.
[CoC]: https://github.com/xmnlab/rxiv-restapi.git/coc/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the Code of Conduct
required: true
...


This template has been adopted from [pyhf](https://github.com/scikit-hep/pyhf/tree/main/.github/ISSUE_TEMPLATE)'s excellent bug report template.
55 changes: 55 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## Pull Request description
<!-- Describe the purpose of your PR and the changes you have made. -->

<!-- Which issue this PR aims to resolve or fix? E.g.:
Solve #004
-->

## How to test these changes

<!-- Example:
* run `$ abc -p 1234`
* open the web browser with url localhost:1234
* ...
-->

* ```...```

<!-- Modify the options to suit your project. -->
## Pull Request checklists

This PR is a:
- [ ] bug-fix
- [ ] new feature
- [ ] maintenance

About this PR:
- [ ] it includes tests.
- [ ] the tests are executed on CI.
- [ ] the tests generate log file(s) (path).
- [ ] pre-commit hooks were executed locally.
- [ ] this PR requires a project documentation update.

Author's checklist:
- [ ] I have reviewed the changes and it contains no misspelling.
- [ ] The code is well commented, especially in the parts that contain more complexity.
- [ ] New and old tests passed locally.

## Additional information

<!-- Add any screenshot that helps to show the changes proposed -->

<!-- Add any other extra information that would help to understand the changes proposed by this PR -->

## Reviewer's checklist

Copy and paste this template for your review's note:

```
## Reviewer's Checklist
- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved
```
Loading

0 comments on commit 3c49af3

Please sign in to comment.