Skip to content

Commit

Permalink
docs: coc and contribution text
Browse files Browse the repository at this point in the history
  • Loading branch information
yoavniran committed May 12, 2020
1 parent df80e1c commit 5164a26
Show file tree
Hide file tree
Showing 2 changed files with 143 additions and 0 deletions.
56 changes: 56 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@

# Contributor Covenant Code of Conduct

## Our Pledge

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone,
regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.

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

## Our Standards

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

Project maintainers 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.

Project maintainers 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.


## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the project maintainers responsible for enforcement at
[yoavniran](https://github.com/yoavniran) or [@poeticGeek](https://twitter.com/poeticGeek).
All complaints will be reviewed and investigated promptly and fairly.

## 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
87 changes: 87 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Contributing

Contributions by the community are more than welcome.
By contributing to React-Uploady, you agree to abide by the [code of conduct](CODE_OF_CONDUCT.md).

## Reporting Issues and Asking Questions

Before opening an issue, please search the [issue tracker][tracker] to make sure your issue hasn't already been reported.

## Development

Visit the [Issue tracker][tracker] to find a list of open issues that need attention.

Fork, then clone the repo:
```
git clone https://github.com/your-username/react-uploady.git
```

### Building

```bash
$ yarn install
```
then:

```bash
$ yarn build
```

### Testing

In order to verify there are no issues, run:
```
$ yarn test
```

this will run flow, lint, jest

each one of these has a corresponding script to run separately.

### Storybook

to run SB locally, run

```bash
$ yarn start
```

### E2E

Another verification requires is to running the e2e suite:

```bash
$ yarn e2e
```

Which runs all existing tests on top of the storybook

If you've made any changes. make sure to test them in the storybook.

### New Features

Please open an issue with a proposal for a new feature or refactoring before starting on the work.
We don't want you to waste your efforts on a pull request that we won't want to accept.

New UI features should have a new story added.

New stories and functionality should be tested in the cypress (e2e) suite.

New API features or props must be added to the type definitions of the changed package.

## Submitting Changes

* Open a new issue in the [Issue tracker][tracker]
* Fork the repo.
* Create a new feature branch based off the `master` branch.
* Make sure all unit tests, flow, lint and e2e tests pass locally.
* Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.
Keeping changes small will make it easier to review and accept.

All PRs opened will be considered but final decision is reserved for the project maintainers.

**Thank you for contributing!**

[tracker]: https://github.com/rpldy/react-uploady/issues

0 comments on commit 5164a26

Please sign in to comment.