Skip to content

Commit

Permalink
#2 Add README.md, CONTRIBUTING.md and CODE_OF_CONDUCT.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aohorodnyk committed Nov 27, 2020
1 parent da70dfa commit 869c541
Show file tree
Hide file tree
Showing 3 changed files with 428 additions and 1 deletion.
117 changes: 117 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# 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
[INSERT CONTACT METHOD].
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.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# How To Contribute
We like to encourage you to contribute to the repository.
This should be as easy as possible for you but there are a few things to consider when contributing.
The following guidelines for contribution should be followed if you want to submit an issue, or a pull request.

## Code Of Conduct
All discussion inside the project (issues, PRs, etc.) have to follow [Code Of Conduct](https://github.com/aohorodnyk/gobitflags/blob/main/CODE_OF_CONDUCT.md).

## Questions
If you have any question, you should use [issue ticket](https://github.com/aohorodnyk/gobitflags/issues) as well as for issues/feature requests.
Do not hesitate to use [issue ticket](https://github.com/aohorodnyk/gobitflags/issues) for all your needs.

## How To Prepare
* You need a [GitHub account](https://github.com/join)
* Submit an [issue ticket](https://github.com/aohorodnyk/gobitflags/issues) for your issue, or question if there is no one yet
* Describe the issue and include steps to reproduce if it's a bug
* Ensure to mention the earliest version that you know is affected
* If you are able and want to fix this, fork the repository on GitHub
* If fix is small you can just [create a pull request](https://github.com/aohorodnyk/gobitflags/pulls) with your changes
* If you want to do some changes in API or request big feature, submit an ticket before [issue ticket](https://github.com/aohorodnyk/gobitflags/issues) to save your time

## Make Changes
* In your forked repository, create a topic branch for your upcoming patch. (e.g. `feature-autoplay` or `bugfix-ios-crash`)
* Usually this is based on the `main` branch
* Create a branch based on `main`
* Please avoid working directly in the `main` branch directly
* Make sure you stick to the coding style that is used already
* Make commits of logical units and describe them properly
* Check for unnecessary whitespace and code with `git diff --check` before committing
* If possible, submit tests to your patch/feature, so it can be tested easily
* Assure nothing is broken by running all the tests and your manual tests

## Submit Changes
* Push your changes to a topic branch in your fork of the repository
* Open a pull request to the original repository and choose the right original branch you want to patch
* If not done in commit messages (which you really should do) please reference and update your issue with the code changes, _please do not close the issue yourself_
* Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve it

# Additional Resources
* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
Loading

0 comments on commit 869c541

Please sign in to comment.