Skip to content

Commit

Permalink
CoC and Contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
davesmith00000 committed Jun 6, 2021
1 parent da319cc commit de53127
Show file tree
Hide file tree
Showing 2 changed files with 178 additions and 0 deletions.
129 changes: 129 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@

# Contributor Covenant Code of Conduct

## Our Pledge

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, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

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.

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.

## Scope

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.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

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

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

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

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

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

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

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

### 4. Permanent Ban

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

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

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing guidelines

All efforts to contribute to Tyrian are welcome and encouraged, as the project can only be better with more eyes looking for problems and more minds trying to solve them.

All contributions must be inline with our code of conduct.

Ways to contribute:

## Reporting issues

Think you've found a problem? We'd like to hear about it!

How to report via the [issue tracker](https://github.com/PurpleKingdomGames/tyrian/issues):

> Please raise ONE TICKET PER ISSUE.
1. Try and search for similar issues currently open.
2. If you can't find an issue, raise a new one.
3. Please try to describe a minimal scenario that reproduces the issue.

## Updating documentation

Game engines are complicated, especially for new people, and so are only as good as their documentation. If you like to help update our docs, please raise a Pull Request against the [documentation website repo](https://github.com/PurpleKingdomGames/tyrian-website).

## Writing code for Tyrian

Tyrian is complicated and the main authors have a roadmap for it's direction. Having said that, we do want people to feel empowered to join in!

Please consider the following:

1. Only fix one thing at a time.
2. Small, easy to digest, minimal change Pull Requests are the easiest to merge.
3. Discuss, discuss, discuss. The bigger the change, the more critical it is to tell us what you're up to.

> If you submit a huge, difficult to process Pull Request without having discussed it with the maintainers, we are under no obligation to accept your work.
### Minor improvements

Correcting a misleading comment? Spotted a couple of lines that look off? Adding tests to existing code without changing the code itself? Please go right ahead and raise a PR.

### Larger changes

Please raise an issue on the project, explain what you intend to do and indicate that you'd like to work on the fix.

## Donations and sponsorship

Contributions are based on time or money, and building and maintaining Tyrian requires both. If you'd like to help cover our costs, help pay for development or just buy us a cup of coffee, we'll be very grateful.

Please look for the sponsorship button on the [tyrian github repository](https://github.com/PurpleKingdomGames/tyrian).

0 comments on commit de53127

Please sign in to comment.