Updated for 2024

 + New github templates for issues and PRs etc.
 + Updated cc year
 + added template GH action examples (see first GH action tests)
 + updated circle-ci to use newer python versions

Author: reactive-firewall

.circleci/config.yml

@@ -5,6 +5,9 @@ jobs:
       - image: circleci/python:3.7
       - image: circleci/python:3.8
       - image: circleci/python:3.9
+      - image: circleci/python:3.10
+      - image: circleci/python:3.11
+      - image: circleci/python:3.12
     environment:
       CI: cicleci
       DEBIAN_FRONTEND: noninteractive
@@ -44,6 +47,9 @@ jobs:
       - image: circleci/python:3.7
       - image: circleci/python:3.8
       - image: circleci/python:3.9
+      - image: circleci/python:3.10
+      - image: circleci/python:3.11
+      - image: circleci/python:3.12
     parallelism: 2
     environment:
       CI: cicleci
@@ -91,6 +97,9 @@ jobs:
       - image: circleci/python:3.7
       - image: circleci/python:3.8
       - image: circleci/python:3.9
+      - image: circleci/python:3.10
+      - image: circleci/python:3.11
+      - image: circleci/python:3.12
     parallelism: 2
     environment:
       CI: cicleci

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct for Python Template
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Unethical, malicious, or other 'Black-hat' hacking activity that harms the
+overall security of the project
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <ADMIN EMAIL>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,149 @@
+## Contributing
+You are here to help the Python Multicast Project? Awesome, feel welcome and read the following sections in order to know what and how to work on something. If you get stuck at any point you can create a ticket on GitHub.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
+
+
+When reporting an issue, please list the version of Python Multicast Library you are using and any relevant information about your software environment (python version, OS type and version, etc). Also avoid vague language like "it doesn't work." Please describe as specifically as you can what behavior you are actually seeing (eg: an error message? a nil return value?).
+
+
+For all contributions, please respect the following guidelines:
+
+Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
+- Do not commit changes to files that are irrelevant to your feature or bugfix (eg: .gitignore).
+- Do not add new external dependencies unless ABSOLUTELY necessary (these could cause Load Errors on certain systems).
+- Add new tests for new code if able (otherwise add descriptive pseudo-tests as issues).
+- Be willing to accept criticism and work on improving your code; care must be taken not to introduce bugs or vulnerabilities.
+
+#### Known Issues and Possible Improvements
+
+For Details on current issues:
+- see [Issues](https://github.com/reactive-firewall/python-repo/issues)
+
+## Triaging tickets
+Here is a brief explanation on how I triage incoming tickets to get a better sense of what needs to be done on what end.
+
+>>Note
+>>
+>>You will need Triage permission on the project in order to do this. You can ask one of the members of the Team to give you access. (Please join the beta first.)
+
+## Initial triage
+When sitting down to do some triaging work, start with the list of untriaged tickets. Consider all tickets that do not have a label as untriaged. The first step is to categorize the ticket into one of the following categories and either close the ticket or assign an appropriate lable. The reported issue
+
+ *  is not valid
+If you think the ticket is invalid comment why you think it is invalid, then close the ticket. Tickets might be invalid if they were already fixed in the past or it was decided that the proposed feature will not be implemented because it does not conform with the overall goal of Pocket-PiAI Project. Also if you happen to know that the problem was already reported, label the ticket with Status: duplicate, reference the other ticket that is already addressing the problem and close the duplicate.
+
+Examples:
+
+This is an issue. (A good starting point for first person to discover)
+
+
+ *  does not provide enough information
+Add the label question if the reported issue does not contain enough information to decide if it is valid or not and ask on the ticket for the required information to go forward. I will re-triage all tickets that have the label question assigned. If the original reporter left new information we can try to re-categorize the ticket. If the reporter did not come back to provide more required information after a long enough time, we will close the ticket (this should be roughly about two weeks).
+
+Examples:
+
+My builds stopped working. Please help! Ask for a link to the build log and for which project is affected.
+
+
+ *  is a valid enhancement proposal
+If the ticket contains an enhancement proposal that aligns with the goals of this repo, then add the label Enhancement. If the proposal seems valid but requires further discussion between core contributors because there might be different possibilities on how to implement the enhancement, then also add the label question.
+
+Examples:
+
+Improve documentation Examples in contribute docs.
+Provide better integration with security feature XYZ
+Refactor module X for better readability (see #48)
+Achieve world domination (also needs the label question)
+
+
+ *  is a valid problem within the code base:
+If it’s a valid bug, then add the label Bug. Try to reference related issues if you come across any.
+
+Examples:
+
+Example Library fails to transmit the leter 'x' or 'y' (logs attached)
+
+
+ *  is a question and needs answering:
+If the ticket contains a question about the code, then move question to FAQ on wiki and add task to answer question on wiki to the issue (or close if already answered).
+
+Examples:
+
+My message was seen by two hosts. Why?
+Why are my builds failing?
+
+
+Helpful links for triaging
+Here is a list of links for contributors that look for work:
+
+Untriaged tickets: Go and triage them!
+
+
+# Reviewing:
+
+This is the checklist that I try to go through for every single pull request that I get. If you're wondering why it takes so long for me to accept pull requests, this is why.
+
+## General
+
+- [ ] Is this change useful to me, or something that I think will benefit others greatly?
+- [ ] Check for overlap with other PRs.
+- [ ] Think carefully about the long-term implications of the change. How will it affect existing projects that are dependent on this? How will it affect my projects? If this is complicated, do I really want to maintain it forever? Is there any way it could be implemented as a separate package, for better modularity and flexibility?
+
+## Check the Code
+
+- [ ] If it does too much, ask for it to be broken up into smaller PRs.
+- [ ] Does it pass `make test-style` (flake8, etc.)?
+- [ ] Is it consistent?
+- [ ] Review the changes carefully, line by line. Make sure you understand every single part of every line. Learn whatever you do not know yet.
+- [ ] Take the time to get things right. PRs almost always require additional improvements to meet the bar for quality. Be very strict about quality. This usually takes several commits on top of the original PR.
+
+## Check the Tests
+
+- [ ] Does it have tests? If not:
+
+	- [ ] Comment on the PR "Can you please add tests for this code to `tests/test_blah.py`", or...
+	- [ ] Write the tests yourself.
+
+- [ ] Do the tests pass for all of the following? If not, write a note in the PR, or fix them yourself.
+
+	- [ ] Python 3.8 - Mac
+	- [ ] Python 3.8 - Linux (OPTIONAL)
+	- [ ] Python 3.9 - Linux
+	- [ ] Python 3.9 (or Newer) - Mac
+	- [ ] Python 3.10 - Linux
+	- [ ] Python 3.11 - Linux
+	- [ ] Python 3.12 - Linux
+	- [ ] Python any - Windows (OPTIONAL)
+
+## Check the Docs
+
+- [ ] Does it have docs? If not:
+
+	- [ ] Comment on the PR "Can you please add docs for this feature to the wiki", or...
+	- [ ] Write the docs yourself.
+
+- [ ] If any new functions/classes are added, do they contain docstrings?
+
+## Credit the Authors
+
+- [ ] Add name and URL to `README.md` for security fixes.
+- [ ] Thank them for their hard work.
+
+## Check the copyright year:
+
+- [ ] reads:
+
+> Copyright (c) 2017-2024, Author
+
+
+## Close Issues
+
+- [ ] Merge the PR branch. This will close the PR's issue.
+- [ ] Close any duplicate or related issues that can now be closed. Write thoughtful comments explaining how the issues were resolved.
+
+## Release (optional)
+
+- [ ] Decide whether the changes in master make sense as a major, minor, or patch release.
+- [ ] Look at the clock. If you're tired, release later when you have time to deal with release problems.
+- [ ] Then follow all the steps in [EXAMPLE Release Checklist](https://github.com/reactive-firewall/python-repo/issues/) FIXME!

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,30 @@
+>> Your Issue may have already been reported!
+>> Please check the [list of issues](../) before creating a new one.
+
+## Basic Info
+>> When reporting an issue, please list the version of Python Multicast Library you are using and any relevant information about your software environment:
+ - Python version:
+ >> `python3 --version || python --version`
+ -  OS type
+>>  `uname -a`
+  - [ ] linux
+  - [ ] MacOS (darwin)
+- `multicast` version:
+>> `python3 -m pythonrepo.pythonrepo --version`
+
+
+
+## Steps to Reproduce Issue:
+
+>> Avoid vague language like "it doesn't work." Please describe as specifically as you can what behavior you are actually seeing (eg: an error message? a nil return value?).
+1.
+2.
+3.
+4.
+
+## Logs (If Available):
+>> Please attach any logs from pythonrepo relevant to the bug.
+
+
+## Additional Information:
+>> Anything else relevant to this issue.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: Bug, Failing
+assignees: reactive-firewall
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs** _(optional)_
+If applicable, add logs here to help explain your problem.
+
+**Screenshots** _(optional)_
+If applicable, add screenshots to help explain your problem.
+
+**PiAP Device (please complete the following information):**
+ - OS: [e.g. macOS]
+ - OS Version: [e.g. 22]
+ - Python Version [e.g. 3.9] _(optional)_
+ - Python Template Version: [e.g. v0.5.0]
+
+**Additional context** _(optional)_
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/documentation-gap.md

@@ -0,0 +1,20 @@
+---
+name: Documentation gap
+about: Create a question to help us improve our documentation
+title: I have a question about
+labels: Documentation, Github, question
+assignees: ''
+
+---
+
+**Describe the question**
+A clear and concise question.
+
+**Expected answer form**
+A clear and concise description of what you expected to find in the documentation.
+
+**Related Documentation** __(optional)__
+If applicable, add documentation references to help explain your question.
+
+**Additional context**
+Add any other context about the question here.

.github/ISSUE_TEMPLATE/feature-suggestion.md

@@ -0,0 +1,20 @@
+---
+name: Feature Suggestion
+about: Suggest an idea for this project
+title: Plea for awesome feature
+labels: Design, Enhancement
+assignees: reactive-firewall
+
+---
+
+**Is your feature request related to a problem? Please describe.** _(optional)_
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/volunteer-to-help-on-github.md

@@ -0,0 +1,14 @@
+---
+name: Volunteer to help on Github
+about: Offer to help with the project
+title: Can I help out?
+labels: Github, question, wontfix
+assignees: ''
+
+---
+
+**introduction (introduce yourself)**
+[e.g. Hi I am a template robot.]
+
+**Motivation (why do you want to help)**
+Please describe why you want to help, do you like testing or fixing or something else?

.github/ISSUE_TEMPLATE/volunteer-to-help-template.md

@@ -0,0 +1,14 @@
+---
+name: Volunteer to help template
+about: Offer to help with the project
+title: Can I help out?
+labels: question, wontfix
+assignees: ''
+
+---
+
+**introduction (introduce yourself)**
+[e.g. Hi I am a template robot.]
+
+**Motivation (why do you want to help)**
+Please describe why you want to help, do you like testing or fixing or something else?