Skip to content

Commit 279158d

Browse files
[docs](doc): base files (#91)
Signed-off-by: Ralph Hightower <32745442+RalphHightower@users.noreply.github.com>
1 parent c0d829b commit 279158d

File tree

3 files changed

+79
-93
lines changed

3 files changed

+79
-93
lines changed

CODEOWNERS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Repository Owner
2+
* @RalphHightower
3+
4+
# Ruby Gems are owned by different developers/organizations
5+
# _plugins/ @rubygems

CODE_OF_CONDUCT.md

Lines changed: 57 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,92 @@
1-
# Contributor Covenant Code of Conduct
21

3-
## Our Pledge
2+
# Contributor Covenant 3.0 Code of Conduct
43

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.
4+
## Our Pledge
115

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
6+
We pledge to make our community welcoming, safe, and equitable for all.
147

15-
## Our Standards
8+
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
169

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
1910

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
11+
## Encouraged Behaviors
2712

28-
Examples of unacceptable behavior include:
13+
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
2914

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
15+
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
3816

39-
## Enforcement Responsibilities
17+
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
18+
2. Engaging **kindly and honestly** with others.
19+
3. Respecting **different viewpoints** and experiences.
20+
4. **Taking responsibility** for our actions and contributions.
21+
5. Gracefully giving and accepting **constructive feedback**.
22+
6. Committing to **repairing harm** when it occurs.
23+
7. Behaving in other ways that promote and sustain the **well-being of our community**.
4024

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.
4525

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.
26+
## Restricted Behaviors
5027

51-
## Scope
28+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
5229

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.
30+
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
31+
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
32+
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
33+
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
34+
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
35+
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
36+
7. Behaving in other ways that **threaten the well-being** of our community.
5837

59-
## Enforcement
38+
### Other Restrictions
6039

61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
ralph.hightower@gmail.com.
64-
All complaints will be reviewed and investigated promptly and fairly.
40+
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
41+
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
42+
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
43+
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
6544

66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
6845

69-
## Enforcement Guidelines
46+
## Reporting an Issue
7047

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:
48+
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
7349

74-
### 1. Correction
50+
When an incident does occur, it is important to report it promptly. To report a possible violation, **[NOTE: describe your means of reporting here.]**
7551

76-
**Community Impact**: Use of inappropriate language or other behavior deemed
77-
unprofessional or unwelcome in the community.
52+
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
7853

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.
8254

83-
### 2. Warning
55+
## Addressing and Repairing Harm
8456

85-
**Community Impact**: A violation through a single incident or series
86-
of actions.
57+
**[NOTE: The remedies and repairs outlined below are suggestions based on best practices in code of conduct enforcement. If your community has its own established enforcement process, be sure to edit this section to describe your own policies.]**
8758

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.
59+
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
9460

95-
### 3. Temporary Ban
61+
1) Warning
62+
1) Event: A violation involving a single incident or series of incidents.
63+
2) Consequence: A private, written warning from the Community Moderators.
64+
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
65+
2) Temporarily Limited Activities
66+
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
67+
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
68+
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
69+
3) Temporary Suspension
70+
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
71+
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
72+
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
73+
4) Permanent Ban
74+
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
75+
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
76+
3) Repair: There is no possible repair in cases of this severity.
9677

97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
78+
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
9979

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.
10580

106-
### 4. Permanent Ban
81+
## Scope
10782

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.
83+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
11184

112-
**Consequence**: A permanent ban from any sort of public interaction within
113-
the community.
11485

11586
## Attribution
11687

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).
88+
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
12389

124-
[homepage]: https://www.contributor-covenant.org
90+
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
12591

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.
92+
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).

CONTRIBUTORS.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributors
2+
3+
Thank you very much for contributing to this project!
4+
5+
Due to the way event triggers work with GitHub actions it's a bit harder to test your changes.
6+
7+
Simple changes that can be unit tested can be implemented with the regular workflow where you fork the repo and create a pull request. Note however that the new version of the action won't be executed in the workflows of this repository. We have to rely on the unit tests in this case.
8+
9+
If e.g. environment parameters are changed, the action should be tested end-to-end in a workflow.
10+
11+
To do this, please follow this process:
12+
13+
1. Fork the repo.
14+
2. Create a PR in **your own repo**.
15+
3. The "Lint PR title preview (current branch)" workflow will run the new version and will help you validate the change.
16+
4. Create a PR to this repo with the changes. In this case the preview workflow will fail, but we'll know that it works since you've tested it in the fork. Please include a include a link to a workflow where you've tested the current state of this pull request.
17+
~~5. Don't run `npm run build` to update the `dist` folder as it will be generated on CI during the build~~

0 commit comments

Comments
 (0)