Skip to content

Commit

Permalink
Merge pull request #25 from qoherent/template-updates
Browse files Browse the repository at this point in the history
Issue and PR template updates, adding Black and isort, and removing broken `_get_commit_hash()` implementation
  • Loading branch information
abeigi authored Mar 19, 2024
2 parents 830db29 + 0760427 commit 6549576
Show file tree
Hide file tree
Showing 15 changed files with 256 additions and 89 deletions.
18 changes: 13 additions & 5 deletions .github/CODING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To ensure smooth development, reduce frustration, and minimize conflicts, we kin
contributions must adhere to these guidelines.

Think there's a better approach? We encourage challenges and discussions to continuously enhance and
refine our approach. You're welcome to present your ideas and rationale on our [ideas forum](https://github.com/qoherent/michael/discussions/categories/ideas).
refine our approach. You're welcome to present your ideas and rationale on our [ideas forum](https://github.com/qoherent/ria/discussions/categories/ideas).

### General guidelines

Expand All @@ -32,9 +32,15 @@ automatically integrated into the RIA CLI.

### Python-specific guidelines

We use [Flake8](https://flake8.pycqa.org/en/latest/) for code linting and style enforcement. All Python code must
be formatted in accordance with the Flake8 configuration settings defined in the [tox.ini](../tox.ini) file
in the root of the project.
We utilize [Black](https://black.readthedocs.io/en/stable/) for automated code formatting, with configuration
settings defined in `pyproject.toml`. Please ensure that all code contributions are auto-formatted with Black,
this is important to ensure consistent and reliably formatted code.

We rely on [isort](https://pycqa.github.io/isort/index.html) for import sorting, with configuration settings defined
in `pyproject.toml`. Please use isort to automatically organize your import statements.

We use [Flake8](https://flake8.pycqa.org/en/latest/) for code linting and style. All Python code must be formatted in accordance with the Flake8
configuration settings defined in [tox.ini](../tox.ini).

To ensure a consistent development environment, this project uses [Poetry](https://python-poetry.org/) for dependency management.
[Start here](https://python-poetry.org/docs/basic-usage/) for information on basic Poetry usage. Please refrain from making unnecessary updates to the
Expand Down Expand Up @@ -195,8 +201,10 @@ poetry run pytest
```


4. Confirm your changes are formatted in accordance with our Flake8 style configuration:
4. Confirm your changes are formatted in accordance with our Black, isort, and Flake8 style configurations:
```commandline
black .
isort .
flake8 .
```

Expand Down
29 changes: 12 additions & 17 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,20 @@ labels: bug 🐞, needs triage 📥
assignees: ''

---
<!-- Thank you for submitting a bug report. We value your feedback. Before proceeding with a new issue,
please take a moment to review the issue tracker for any existing reports related to the same bug.
Thank you for submitting a bug report. We value your feedback. Before proceeding with a new issue, please take a
moment to review the issue tracker for any existing reports related to the same bug.

Many user applications of RIA Core require interfacing with external radio hardware. Prior to submitting a
bug report, please confirm that the issue you're experiencing is attributable to RIA Core, rather than your
hardware/driver configuration. If you are unsure, feel free to ask in our [support forum](https://github.com/qoherent/michael/discussions/categories/support).
Many user applications of RIA Core require interfacing with external radio hardware. Prior to submitting
a bug report, please confirm that the issue you're experiencing is attributable to RIA Core, rather than
your hardware/driver configuration. If you are unsure, feel free to ask in our
[support forum](https://github.com/qoherent/ria/discussions/categories/support). -->

**Description:**
[A clear and concise description of the issue.]


**Project Area:**
Which aspect of RIA Core are you experiencing issues with?
- [ ] An importable module (e.g., using `from ria import curate` in your Python project)
- [ ] A project script (e.g., executing `ria curate` from the command line)
- [ ] Project documentation or tutorials, including code snippets and graphics
- [ ] CI or DevOps, including our Pytest test suite
[Which aspect of RIA Core are you experiencing issues with?]


**Steps to Reproduce:**
Expand All @@ -48,15 +44,14 @@ Which aspect of RIA Core are you experiencing issues with?


**Radio Hardware and Driver Information:**
[Please provide any relevant information about your radio hardware and driver
configurations, including the manufacturer and model number or your radio, as well as
driver version details.]
[Please provide any relevant information about your radio hardware and driver configurations, including the
manufacturer and model number or your radio, as well as driver version details.]


**Additional context:**
[Any additional details or context about the issue.]


Once your bug report has been submitted, it will be triaged by an authorized Qoherent team member.
Please wait for the issue to be triaged before starting development. This is to ensure your efforts
are focused effectively. Thank you for your patience and understanding.
<!-- Once your bug report has been submitted, it will be triaged by an authorized Qoherent team member. Please wait
for the issue to be triaged before starting development. This is to ensure your efforts are focused effectively.
Thank you for your patience and understanding. -->
29 changes: 12 additions & 17 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,35 @@ assignees: ''

---

Thank you for submitting a feature request. We value your feedback. Before proceeding with a new issue, please
take a moment to review the issue tracker for any existing requests related to the same feature.
<!-- Thank you for submitting a feature request. We value your feedback. Before proceeding with a new issue,
please take a moment to review the issue tracker for any existing requests related to the same feature.
Please be aware that RIA Core serves as the open-source core of a broader software engineering initiative.
The feature you're requesting might already be available within [RIA Hub](https://riahub.ai/) or through an
alternative Qoherent solution. In such cases, we will, during our triaging process, provide any relevant
information in the issue comments and label the request with `wont fix ❌`.
The feature you're requesting might already be available within [RIA Hub](https://riahub.ai/) or through
an alternative Qoherent solution. In such cases, during our triaging process, we will provide any relevant
information in the issue comments and label the request with `wont fix ❌`. -->

**Description:**
[A clear and concise description of the feature you'd like to see implemented.]


**Project Area:**
To which aspect of RIA Core does this request pertain?
- [ ] The enhancement or addition of an importable module (i.e., using `import ria` in your Python project)
- [ ] The enhancement or addition or a project script (i.e., executing `ria curate` from the command line)
- [ ] Our radio interface tools, such as requesting support for a new radio
- [ ] Project documentation or tutorials, including new or improved code snippets and graphics
- [ ] CI and DevOps, such as new or improved unit tests or GitHub workflows
[To which aspect of RIA Core does this request pertain?]


**Is your feature request related to a problem you're having? If so, please describe:**
[A clear and concise description of the problem you're experiencing. E.g., I'm always frustrated when ...]


**Is your feature request related to a specific project or research initiative in which you're currently involved?
**Is your feature request related to a specific project or research initiative in which you're currently involved?
If so, please describe:**
[A clear and concise description of how your feature request relates to any specific projects or research
initiatives in which you are currently involved.]


**Please share any ideas or suggestions you have for potential solutions:**
[A clear and concise description of any ideas or suggestions you have for potential solutions.
Please include any relevant screenshots or design mockups.]
[A clear and concise description of any ideas or suggestions you have for potential solutions. Please include any
relevant screenshots or design mockups.]


**Describe alternatives you've considered:**
Expand All @@ -51,6 +46,6 @@ Please include any relevant screenshots or design mockups.]
[Any additional details or context about the requested feature.]


Once your feature request has been submitted, it will be triaged by an authorized Qoherent team member.
Please wait for the issue to be triaged before starting development. This is to ensure your efforts are
focused effectively. Thank you for your patience and understanding.
<!-- Once your bug report has been submitted, it will be triaged by an authorized Qoherent team member. Please wait
for the issue to be triaged before starting development. This is to ensure your efforts are focused effectively.
Thank you for your patience and understanding. -->
16 changes: 8 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
**Description:**
[Provide a clear and concise description of the changes and their purpose. Please include any relevant screenshots or
design notes.]
[Provide a clear and concise description of the changes and their purpose. Please include any relevant
screenshots or design notes.]


**Related Issues:**
[Please reference any issues being addressed by this pull request, as well as any related issues.]


**Outstanding Sub-Issues:**
[If there are any outstanding sub-issues or parts of the addressed issues that have not yet been wholly addressed by
this pull request, please describe them here.]
[If there are any outstanding sub-issues or parts of the addressed issues that have not yet been wholly addressed
by this pull request, please describe them here.]


**Tips for the Reviewer:**
Expand All @@ -31,12 +31,12 @@ or whose authorship we cannot verify, may not be accepted.
- [ ] I have included unit tests for my code contributions, and all tests are passing.
- [ ] The docstrings are complete, include doctests demonstrating usage, and are properly formatted.
I have verified that any updates to the project documentation are complete and look okay.
- [ ] I have confirmed all my code contributions are formatted in accordance with the project's Flake8 style
configuration.
- [ ] I have confirmed all my code contributions are formatted in accordance with the project's Flake8, Black,
and isort style configurations.
- [ ] No unnecessary changes have been made to the Poetry lock file, but `pyproject.toml` and the Poetry lock file
have been updated to reflect any dependency changes.
- [ ] I acknowledge that upon the submission of this pull request, Qoherent will assume the copyright for this
contribution.

A heartfelt thank you from everyone at Qoherent and the broader radio community for taking the time to contribute to
RIA Core. 🙏💖
<!-- A heartfelt thank you from everyone at Qoherent and the broader radio community for taking the time to
contribute to RIA Core. 🙏💖 -->
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import os
import sys

sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))

# -- Project information -----------------------------------------------------
Expand Down
Loading

0 comments on commit 6549576

Please sign in to comment.