Skip to content

Commit b8cb2ac

Browse files
JEMcatsJEMcats
committed
Ready for release
1 parent 1094252 commit b8cb2ac

File tree

9 files changed

+951
-1
lines changed

9 files changed

+951
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us address problems
4+
title: "[BUG] "
5+
labels: bug, vulnerability
6+
assignees: ''
7+
8+
---
9+
10+
Before you start, please check that you are **NOT** on a beta version of the software.
11+
12+
**Describe the bug**
13+
A clear and concise description of what the bug is.
14+
15+
**To Reproduce**
16+
Steps to reproduce the behavior:
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. Scroll down to '....'
20+
4. See error
21+
22+
**Expected behavior**
23+
A clear and concise description of what you expected to happen.
24+
25+
**Device Details (please complete the following information):**
26+
- OS: [e.g. MacOS]
27+
- Browser: [e.g. Safari]
28+
- Version [e.g. 15]
29+
30+
**Log File:**
31+
Upload your log file here, make sure to edit out any sensitive info.
32+
33+
**Additional context**
34+
Add any other context about the problem here.
35+
36+
Please apply any labels that are related to this request

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.
21+
22+
Please apply any labels that are related to this request.

‎.github/ISSUE_TEMPLATE/vulnerability-report.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Vulnerability report
3+
about: Report a vulnerability in our codebase
4+
title: "[VULNERABLLITY] "
5+
labels: priority, vulnerability
6+
assignees: ''
7+
8+
---
9+
10+
**What has a vulnerability?**
11+
Tell you what part of our code is vulnerable.
12+
13+
**How can we improve?**
14+
Give us steps to improve this problem.
15+
16+
Please apply any labels that are related to this request.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!--
2+
Thank you for contributing to our project!
3+
4+
Please refrain from deleting any text from this template, unless specifically instructed to do so.
5+
-->
6+
7+
## Breaking Change
8+
<!--
9+
If your pull request (PR) contains a breaking change for existing users, it is crucial to inform them of the affected functionality, provide instructions on how to restore it, and explain the rationale behind the change.
10+
Note: Remove this section if your PR does not constitute a breaking change.
11+
-->
12+
13+
## Proposed Change
14+
<!--
15+
Describe the comprehensive scope of your proposed changes in this section to convey to the maintainers the reasons for accepting your pull request. If your PR addresses a bug or resolves a feature request, kindly link to the relevant issue in the additional information section.
16+
-->
17+
18+
## Type of Change
19+
<!--
20+
Classify the nature of your PR change.
21+
Please select only one option!
22+
If your PR requires multiple options, consider splitting it into multiple PRs to facilitate a more efficient and expedited code review process.
23+
-->
24+
25+
- [ ] Bugfix (non-breaking change that resolves an issue)
26+
- [ ] New Feature (which introduces functionality to an existing function)
27+
- [ ] New Function (a new way to do something, for example make a pane of glass)
28+
- [ ] Breaking Change (fix or feature that disrupts existing functionality)
29+
30+
## Additional Information
31+
<!--
32+
Provide detailed information that will assist JEMcats-Software in evaluating your PR.
33+
Please complete any applicable additional details.
34+
-->
35+
36+
- This PR addresses or resolves issue:
37+
- This PR is related to issue:
38+
39+
## Checklist
40+
<!--
41+
Mark the appropriate boxes. You can also complete this checklist after creating the PR. If you have any uncertainties, please do not hesitate to seek clarification. We are here to assist you. This serves as a reminder of the criteria we will consider before merging your code.
42+
-->
43+
44+
- [ ] All code is thoroughly tested and functions locally.
45+
- [ ] There is minimal to no commented-out code in this PR.
46+
- [ ] Readme files are added or updated <!-- remove line if not applicable -->

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
development@jemcats.software.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributing
2+
Fork the ``dev`` branch.
3+
4+
Make your changes in your fork.
5+
6+
Fill out the pull request form.
7+
8+
Open a pull request.

0 commit comments

Comments
 (0)