adding github docs; updating workflows

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at https://www.contributor-covenant.org/version/1/3/0/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

.github/CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing to django-<my_package>
+
+First off, thank you for considering contributing to django-<my_package>!
+
+The following is a set of guidelines for contributing to this project. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## Table of Contents
+
+1. [Code of Conduct](#code-of-conduct)
+2. [How Can I Contribute?](#how-can-i-contribute)
+    - [Reporting Bugs](#reporting-bugs)
+    - [Suggesting Enhancements](#suggesting-enhancements)
+    - [Pull Requests](#pull-requests)
+3. [Development Setup](#development-setup)
+4. [Style Guide](#style-guide)
+5. [License](#license)
+
+<br/>
+
+## Code of Conduct
+
+This project and everyone participating in it are governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [maintainer email].
+
+<br/>
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+- Before creating bug reports, please check the [existing issues](https://github.com/djangoaddicts/<my_package>/issues) as you might find that the issue has already been reported.
+- When creating a bug report, please include a clear and concise description of the problem and steps to reproduce it.
+
+### Suggesting Enhancements
+
+- Before creating enhancement suggestions, please check the [list of open issues](https://github.com/djangoaddicts/<my_package>/issues) as you might find that the suggestion has already been made.
+- When creating an enhancement suggestion, please provide a detailed description and, if possible, an implementation proposal.
+
+### Pull Requests
+
+- Provide a clear and concise description of your pull request.
+- Ensure you have tested your changes thoroughly.
+- Add/update unittests as nessessary.
+- Make sure code quaility tools run successfully. 
+
+    Merging contributions requires passing the checks configured with the CI. This includes running tests, linters, and other code quaility tools successfully on the currently officially supported Python and Django versions.
+
+<br/>
+
+## Development
+
+You can contribute to this project forking it from GitHub and sending pull requests.
+
+First [fork](https://help.github.com/en/articles/fork-a-repo) the
+[repository](https://github.com/djangoaddicts/<my_package>) and then clone it:
+
+```shell
+git clone [email protected]:<you>/<my_package>.git
+```
+
+Create a virtual environment and install dependancies:
+
+```shell
+cd django-<my_package>
+python -m venv venv
+source venv/bin/activate
+pip install .[dev]
+```
+
+Unit tests are located under the tests directory and can be executed via pytest:
+
+```shell
+pytest
+```
+
+
+<br/>
+
+## Style Guide
+
+Follow the coding style outlined in [STYLE_GUIDE.md](STYLE_GUIDE.md).
+
+<br/>
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [GNU-3 license](../LICENSE).

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,48 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: description
+    attributes:
+      label: Descriription
+      description: A clear and concise description of what the bug is. Include any applicable screenshots or files.
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce the behavior
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    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: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Conceler/<my_package>/blob/main/.github/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,34 @@
+name: Feature Request
+description: File a feature request
+title: "[Feature Request]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: Is your feature request related to a problem? Please describe.
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Conceler/conceler/blob/main/.github/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/question.yaml

@@ -0,0 +1,26 @@
+name: Question
+description: Ask a question
+title: "[Question]: "
+labels: ["question"]
+body:
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: Describe your question or request for clarification
+      placeholder: Please provide as much detail as possible
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context or information relevant to your question.
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Conceler/conceler/blob/main/.github/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+## Pull Request
+
+### Description:
+Provide a brief description of the changes introduced by this pull request
+
+### Related Issue(s):
+Add links to applicable Github issues
+- #1
+- #2
+
+### Checklist:
+- [ ] All code quality checks pass
+- [ ] Code follows the project's style guide
+- [ ] Documentation has been updated
+
+
+### Testing:
+- [ ] Existing tests provided necessary coverage
+- [ ] Applicable tests have been added/updated
+- [ ] This change does not require testing