Skip to content

Commit

Permalink
Initial Setup.
Browse files Browse the repository at this point in the history
  • Loading branch information
AzorianMatt committed Jan 16, 2024
0 parents commit 9226d07
Show file tree
Hide file tree
Showing 60 changed files with 3,776 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/ACKNOWLEDGMENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Acknowledgments

Coming eventually?
11 changes: 11 additions & 0 deletions .github/AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Authors

This is the list of the Reflective library's significant contributors.

This does not necessarily list everyone who has contributed code,
especially since many employees of one corporation may be contributing.

To see the full list of contributors, see the revision history in
source control.

- <a href="https://azorian.solutions" target="_blank">Azorian Solutions LLC</a> &lt;<a href="mailto:[email protected]">[email protected]</a>&gt;
3 changes: 3 additions & 0 deletions .github/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Change Log

Coming eventually?
3 changes: 3 additions & 0 deletions .github/CODEOWNERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code Owners

- <a href="https://azorian.solutions" target="_blank">Azorian Solutions LLC</a> &lt;<a href="mailto:[email protected]">[email protected]</a>&gt;
74 changes: 74 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Code of Conduct

## 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:

* 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
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* 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 [[email protected]](mailto:[email protected]). 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/
10 changes: 10 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Reflective

**Looking for help?** Try taking a look at the project's
[Support Guide](https://github.com/AzorianSolutions/reflective/blob/main/docs/wiki/support/README.md) or joining
our [Discord Server](https://discord.azorian.solutions).

## Contribution Guide

Please see the project's [Contribution Guide](https://github.com/AzorianSolutions/reflective/blob/main/docs/wiki/contributing/README.md)
for information on how to contribute to the project.
11 changes: 11 additions & 0 deletions .github/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributors

This is a list of people / organizations that are currently contributing to the project in
some way.

This does not necessarily list everyone who has contributed code.

To see the full list of contributors, see the revision history in
source control.

- <a href="https://azorian.solutions" target="_blank">Azorian Solutions LLC</a> &lt;<a href="mailto:[email protected]">[email protected]</a>&gt;
9 changes: 9 additions & 0 deletions .github/FUNDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Funding

## Funding

Like my work?

<a href="https://www.buymeacoffee.com/AzorianMatt" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>

**Want to sponsor me?** Please visit my organization's [sponsorship page](https://github.com/sponsors/AzorianSolutions).
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [AzorianSolutions]
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: 🐛 Bug Report
description: Report a reproducible bug in a specific release of Reflective
labels: ["bug / broken-feature"]
body:
- type: markdown
attributes:
value: >
**NOTE:** This form is only for reporting _reproducible bugs_ in a current Reflect
installation. If you're having trouble with installation or just looking for
assistance with using Reflect, please visit our
[discussion forum](https://github.com/AzorianSolutions/reflective/discussions) instead.
- type: dropdown
attributes:
label: Reflective version
description: What version of Reflective are you currently running?
options:
- "0.1.0"
- "0.1.2"
- "0.1.3"
- "0.1.4"
- "0.1.5"
- "0.1.6"
- "0.1.7"
- "0.1.8"
- "0.1.9"
- "1.0.0"
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: >
Describe in detail the exact steps that someone else can take to
reproduce this bug using the current stable release of Reflect. Begin with detailing the
creation of any necessary data objects and call out every operation being
performed explicitly.
placeholder: |
1. Import core Reflect object using `from reflect import Reflect`
2. Create the data structure using `data = {'attr1': {'key1': 'value1'}, 'tags': ['tag1', 'tag2']}`
3. Create a new instance of Reflect using `r = Reflect.reflect(data)`
4. Print the value using `print(r.attr1['key1']('tags.0')`
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: I should have received the value for the given reference.
validations:
required: true
- type: textarea
attributes:
label: Observed Behavior
description: What happened instead?
placeholder: An exception occurred when I execute the code. That exception ...
validations:
required: true
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
# Reference: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: false
contact_links:
- name: 📖 Contribution Guide
url: https://github.com/AzorianSolutions/reflective/blob/main/docs/wiki/contributing/README.md
about: "Please read through our contribution guide before opening an issue or pull request"
- name: ❓ Discussion
url: https://github.com/AzorianSolutions/reflective/discussions
about: "If you're just looking for help, try starting a discussion instead"
- name: 💬 Discord Server
url: https://discord.azorian.solutions
about: "Join our Discord server to discuss the project with other users and developers"
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_change.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: 📖 Documentation Change
description: Suggest an addition or modification to the Reflective documentation
labels: ["docs / request"]
body:
- type: dropdown
attributes:
label: Change Type
description: What type of change are you proposing?
options:
- Addition
- Correction
- Removal
- Cleanup (formatting, typos, etc.)
validations:
required: true
- type: dropdown
attributes:
label: Area
description: To what section of the documentation does this change primarily pertain?
options:
- Features
- Installation/upgrade
- Getting started
- Configuration
- Customization
- Debug
- Administration
- Development
- Other
validations:
required: true
- type: textarea
attributes:
label: Proposed Changes
description: Describe the proposed changes and why they are necessary.
validations:
required: true
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
name: ✨ Feature Request
description: Propose a new Reflective feature or enhancement
labels: ["feature / request"]
body:
- type: markdown
attributes:
value: >
**NOTE:** This form is only for submitting well-formed proposals to extend or modify
Reflect in some way. If you're trying to solve a problem but can't figure out how, or if
you still need time to work on the details of a proposed new feature, please start a
[discussion](https://github.com/AzorianSolutions/reflective/discussions) instead.
- type: dropdown
attributes:
label: Reflective version
description: What version of Reflective are you currently running?
options:
- "0.1.0"
- "0.1.2"
- "0.1.3"
- "0.1.4"
- "0.1.5"
- "0.1.6"
- "0.1.7"
- "0.1.8"
- "0.1.9"
- "1.0.0"
validations:
required: true
- type: dropdown
attributes:
label: Feature type
options:
- Access Feature
- Manipulation Feature
- Query Feature
- Presentation Feature
- Other change to existing functionality
validations:
required: true
- type: textarea
attributes:
label: Proposed functionality
description: >
Describe in detail the new feature or behavior you are proposing. Include any specific changes
to class methods, implicit behaviors, etc. The more detail you provide here, the
greater chance your proposal has of being discussed. Feature requests which don't include an
actionable implementation plan will be rejected.
validations:
required: true
- type: textarea
attributes:
label: Use case
description: >
Explain how adding this functionality would benefit Reflect users. What need does it address?
validations:
required: true
- type: textarea
attributes:
label: External dependencies
description: >
List any new dependencies on external libraries or services that this new feature would
introduce. For example, does the proposal require the installation of a new Python package?
(Not all new features introduce new dependencies.)
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/housekeeping.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: 🏡 Housekeeping
description: A change pertaining to the codebase itself (developers only)
labels: ["mod / change-request"]
body:
- type: markdown
attributes:
value: >
**NOTE:** This template is for use by maintainers only. Please do not submit
an issue using this template unless you have been specifically asked to do so.
- type: textarea
attributes:
label: Proposed Changes
description: >
Describe in detail the new feature or behavior you'd like to propose.
validations:
required: true
- type: textarea
attributes:
label: Justification
description: Please provide justification for the proposed change(s).
validations:
required: true
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!--
Thank you for your interest in contributing to the Reflective project! Please note that our contribution
policy requires that a feature request or bug report be approved and assigned prior to opening a pull request.
This helps avoid wasted time and effort on a proposed change that we might want to or be able to accept.
IF YOUR PULL REQUEST DOES NOT REFERENCE AN ISSUE WHICH HAS BEEN ASSIGNED TO YOU, IT WILL BE CLOSED AUTOMATICALLY!
Please specify your assigned issue number on the line below.
-->
### Issue: #1234

<!--
Please include a summary of the proposed changes below.
-->
31 changes: 31 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Security Policy

## No Warranty

Per the terms of the MIT license, Reflective is offered "as is" and without any guarantee or warranty pertaining to its operation. While every reasonable effort is made by its maintainers to ensure the product remains free of security vulnerabilities, users are ultimately responsible for conducting their own evaluations of each software release.

## Recommendations

Administrators are encouraged to adhere to industry best practices concerning the secure operation of software, such as:

* Do not expose your Reflective installation to the public Internet
* Do not permit multiple users to share an account
* Enforce minimum password complexity requirements for user accounts
* Prohibit access to your database from clients other than the Reflective services
* Keep your deployment updated to the most recent stable release

## Reporting a Suspected Vulnerability

If you believe you've uncovered a security vulnerability and wish to report it confidentially, you may do so via email. Please note that any reported vulnerabilities **MUST** meet all the following conditions:

* Affects the most recent stable release of Reflective, or a current beta release
* Affects a Reflective instance installed and configured per the official documentation
* Is reproducible following a prescribed set of instructions

Please note that we **DO NOT** accept reports generated by automated tooling which merely suggest that a file or file(s) _may_ be vulnerable under certain conditions, as these are most often innocuous.

If you believe that you've found a vulnerability which meets all of these conditions, please [submit a draft security advisory](https://github.com/AzorianSolutions/reflective/security/advisories/new) on GitHub, or email a brief description of the suspected bug and instructions for reproduction to **[email protected]**.

### Bug Bounties

As Reflective is provided as free open source software, we do not offer any monetary compensation for vulnerability or bug reports, however your contributions are greatly appreciated.
Loading

0 comments on commit 9226d07

Please sign in to comment.