Skip to content

Commit

Permalink
Add CONTRIBUTING and update README πŸ“–
Browse files Browse the repository at this point in the history
  • Loading branch information
slashmo committed Dec 9, 2018
1 parent 56cfb74 commit 880be29
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 3 deletions.
Binary file removed .github/jumbotron.jpg
Binary file not shown.
Binary file added .github/logo_text_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 76 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, 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.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

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

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

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

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
File renamed without changes.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
![Ocelot logo](.github/jumbotron.jpg)
<img src=".github/logo_text_dark.png" alt="Ocelot logo" height="70">

# GraphQL Swift
This is a **work in progress** implementation of the [GraphQL spec](https://github.com/facebook/graphql) written in Swift. Head over to our [Development project](https://github.com/ocelotgraphql/graphql-swift/projects/1) to see the current progress.

> ⚠️ This is a **work in progress** implementation of the [GraphQL spec](https://github.com/facebook/graphql) written in Swift. Head over to our [Development project](https://github.com/ocelotgraphql/graphql-swift/projects/1) to see the current progress.
## Contributing

Ocelot is currently in it's **very early stages**. As soon as we have a clearly defined roadmap we'll label issues contribution friendly.
You can follow the ongoing development through this repository's [GitHub project board](https://github.com/ocelotgraphql/ios/projects/1).

## Installation

> Unless the only thing you need is a GraphQL Lexer installing this library is not yet recommended.
### Swift Package Manager

As we don't have any releases yet you have to specify the `master` branch instead of a version.
Add the following line to your `Package.swift` file's dependencies array:

``` swift
.package(url: "https://github.com/ocelotgraphql/graphql-swift", .branch("master"))
```

0 comments on commit 880be29

Please sign in to comment.