Skip to content

Commit df25946

Browse files
JordanWelsmanJordanWelsman
authored
Merge pull request #11 from JordanWelsman/context-files
To-do list complete. Merging now.
2 parents 80395f0 + 33da522 commit df25946

File tree

5 files changed

+152
-0
lines changed

5 files changed

+152
-0
lines changed

‎CITATION.cff

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
authors:
4+
- family-names: "Welsman"
5+
given-names: "Jordan"
6+
orcid: "https://orcid.org/0000-0002-2882-594X"
7+
title: "jutils"
8+
version: 0.4.1
9+
date-released: 2023-02-18
10+
url: "https://github.com/JordanWelsman/jutils"

‎CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Code Owners
2+
3+
# Assigned as reviewer for all PRs
4+
* @JordanWelsman

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to jutils
2+
3+
Thank you for your interest in contributing towards this project. The owners of this repository welcome contributions from the open source community with open arms.
4+
5+
## Getting started
6+
7+
Please review the [Code of Conduct](CODE_OF_CONDUCT.md) to get familiar the dos and don'ts of contributing. Please also see our [contributing guidelines](#how-to-contribute), which provides a general reference on the process of contributing to the project.
8+
9+
## How to contribute
10+
11+
We welcome contributions in many forms, including bug reports, feature requests, documentation improvements, and code contributions. To get started, please follow these steps:
12+
13+
### Request a feature or propose an idea
14+
15+
1. Create a new post on the [Discussion Board](https://github.com/JordanWelsman/jutils/discussions).
16+
2. Work with the existing developers on a plan of implementation.
17+
3. Fork this repository and create a new branch for your contribution.
18+
4. Make your changes and commit them to your branch.
19+
5. Submit a pull request to this repository.
20+
6. We will review your changes and provide feedback as needed.
21+
22+
### Report or fix a bug
23+
24+
1. Submit a GitHub issue to the issue tracker.
25+
2. If you would like to fix the bug yourself, comment that you want to work on it.
26+
3. Once you have approval, fork this repository and create a new branch for your bugfix.
27+
4. Make your changes and commit them to your branch.
28+
5. Submit a pull request to this repository.
29+
6. We will review your changes and provide feedback as needed.
30+
31+
> If you need advice on your contribution or context on the project code, don't hesitate to reach out on our [Discussion Board](https://github.com/JordanWelsman/jutils/discussions).
32+
33+
34+
## Code ownership
35+
36+
Once you have successfuly contributed to this project, you should add yourself to the [Code Owners](CODEOWNERS) directory. This will notify you any time someone wants to further add to your contribution.
37+
38+
_Happy contributing!_ :pen:

‎SECURITY.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Security Policy
2+
3+
## Reporting a vulnerability
4+
5+
If you discover a security vulnerability within this project, please send an email to [Jordan Welsman](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
6+
7+
Please do not publicly disclose any security vulnerabilities until they have been addressed by the project maintainers.
8+
9+
## Supported versions
10+
11+
| Version | Supported |
12+
| ------- | ------------------ |
13+
| 0.4.x | :white_check_mark: |
14+
| 0.3.x | :x: |
15+
| 0.2.x | :x: |
16+
| 0.1.x | :x: |
17+
| 0.0.x | :x: |

0 commit comments

Comments
 (0)