Skip to content

Commit f3c3f0d

Browse files
grumBitgrumBit
authored
Merge pull request #5 from grumBit/community_standards
Adds the community standards suggested by github.
2 parents 3fcf265 + 7c95410 commit f3c3f0d

File tree

5 files changed

+266
-1
lines changed

5 files changed

+266
-1
lines changed

‎.github/pull_request_template.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### Description
2+
3+
### Changes
4+
5+
### Issues
6+
7+
closes #xxx

‎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+
bitjugglers@gmail.com.
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: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Contributing
2+
3+
First off, thanks for taking the time to contribute!
4+
5+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them.
6+
7+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
8+
>
9+
> - Star the project
10+
> - Tweet about it
11+
> - Refer this project in your project's readme
12+
13+
## Table of Contents
14+
15+
- [Contributing](#contributing)
16+
- [Table of Contents](#table-of-contents)
17+
- [Code of Conduct](#code-of-conduct)
18+
- [I Have a Question](#i-have-a-question)
19+
- [I Want To Contribute](#i-want-to-contribute)
20+
- [Reporting Bugs](#reporting-bugs)
21+
- [Before Submitting a Bug Report](#before-submitting-a-bug-report)
22+
- [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
23+
- [Suggesting Enhancements](#suggesting-enhancements)
24+
- [Before Submitting an Enhancement](#before-submitting-an-enhancement)
25+
- [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
26+
- [Attribution](#attribution)
27+
28+
## Code of Conduct
29+
30+
This project and everyone participating in it is governed by the [Code of Conduct](blob/master/CODE_OF_CONDUCT.md).
31+
When participating, please uphold this code. Please report unacceptable behavior
32+
to **[bitjugglers@gmail.com](mailto:bitjugglers@gmail.com)**.
33+
34+
## I Have a Question
35+
36+
Before asking a question, check if any existing [Issues](/issues) might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. If at doesn't help please open a new [Issue](/issues/new).
37+
38+
## I Want To Contribute
39+
40+
> ### Legal Notice
41+
>
42+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
43+
44+
### Reporting Bugs
45+
46+
#### Before Submitting a Bug Report
47+
48+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
49+
50+
- Make sure that you are using the latest version.
51+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)).
52+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](issues?q=label%3Abug).
53+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
54+
- Collect information about the bug:
55+
- Stack trace (Traceback)
56+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
57+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
58+
- Possibly your input and the output
59+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
60+
61+
#### How Do I Submit a Good Bug Report?
62+
63+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.
64+
65+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
66+
67+
- Open an [Issue](/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
68+
- Explain the behavior you would expect and the actual behavior.
69+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
70+
- Provide the information you collected in the previous section.
71+
72+
Once it's filed:
73+
74+
- The project team will label the issue accordingly.
75+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
76+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
77+
78+
### Suggesting Enhancements
79+
80+
This section guides you through submitting an enhancement suggestion for CONTRIBUTING.md, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
81+
82+
#### Before Submitting an Enhancement
83+
84+
- Make sure that you are using the latest version.
85+
- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
86+
- Perform a [search](/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
87+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
88+
89+
#### How Do I Submit a Good Enhancement Suggestion?
90+
91+
Enhancement suggestions are tracked as [GitHub issues](/issues).
92+
93+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
94+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
95+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
96+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
97+
- **Explain why this enhancement would be useful** to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
98+
99+
## Attribution
100+
101+
This guide is based on the **contributing.md**. [Make your own](https://contributing.md/)!

‎SECURITY.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
4+
- [Security Policy](#security-policy)
5+
- [Supported Versions](#supported-versions)
6+
- [Reporting a Vulnerability](#reporting-a-vulnerability)
7+
8+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
9+
10+
# Security Policy
11+
12+
## Supported Versions
13+
14+
These versions of this project are currently being supported with security updates;
15+
16+
| Version | Supported |
17+
| -------- | ------------------ |
18+
| < 1.0.9 | :x: |
19+
| >= 1.0.9 | :white_check_mark: |
20+
21+
## Reporting a Vulnerability
22+
23+
Please report (suspected) security vulnerabilities by creating an [issue](https://github.com/grumbit/aws_cron_expression_validator/issues), which will send
24+
an automated email to **[bitjugglers@gmail.com](mailto:bitjugglers@gmail.com)**.
25+
26+
You will hopefully receive a response within 2-3 days, however, this is a personal
27+
side-project, so it may take longer. If the issue is confirmed, a patch will be released
28+
as soon as possible depending on complexity but hopefully within a few days.

‎pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "aws_cron_expression_validator"
7-
version = "1.0.9"
7+
version = "1.0.10"
88
authors = [
99
{ name="Graham Coster", email="bitjugglers@gmail.com" },
1010
]
@@ -22,6 +22,7 @@ classifiers = [
2222
"Homepage" = "https://github.com/grumBit/aws_cron_expression_validator.git"
2323
"Bug Tracker" = "https://github.com/grumBit/aws_cron_expression_validator/issues"
2424
"Source" = "https://github.com/grumBit/aws_cron_expression_validator"
25+
"Security Policy" = "https://github.com/grumbit/aws_cron_expression_validator/blob/master/SECURITY.md"
2526

2627
[tool.pytest.ini_options]
2728
addopts = "--cov-report html --cov-report term-missing --cov-fail-under 95"

0 commit comments

Comments
 (0)