This repository has been archived by the owner on Mar 12, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates all of our public docs and adds our license file
- Loading branch information
1 parent
418e5f1
commit bd4ad89
Showing
5 changed files
with
243 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# 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, gender identity and expression, level of experience, | ||
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 contact@textile.io. 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 [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
# Contributing to Textile | ||
|
||
The following is a set of guidelines for contributing to Textile Mobile and its | ||
related projects, which are hosted in the [Textile organization](https://github.com/textileio). These are just guidelines, not rules. Use your best judgment, and | ||
feel free to propose changes to this document in a pull request. | ||
|
||
Note that Textile is an evolving project, so expect things to change over | ||
time as the team learns, listens and refines how we work with the community. | ||
|
||
#### Table Of Contents | ||
|
||
[What should I know before I get started?](#what-should-i-know-before-i-get-started) | ||
* [Code of Conduct](#code-of-conduct) | ||
|
||
[How Can I Contribute?](#how-can-i-contribute) | ||
* [Reporting Bugs](#reporting-bugs) | ||
* [Suggesting Enhancements](#suggesting-enhancements) | ||
|
||
[Additional Notes](#additional-notes) | ||
* [Issue Labels](#issue-labels) | ||
|
||
## What should I know before I get started? | ||
|
||
### Code of Conduct | ||
|
||
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). | ||
By participating, you are expected to uphold this code. | ||
Please report unacceptable behavior to [contact@textile.io](mailto:contact@textile.io). | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
This section guides you through submitting a bug report for Textile Mobile. | ||
Following these guidelines helps maintainers and the community understand your | ||
report, reproduce the behavior, and find related reports. | ||
|
||
Before creating bug reports, please check [this list](https://github.com/textileio/textile-mobile/labels/bug) | ||
as you might find out that you don't need to create one. When you are creating | ||
a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). | ||
|
||
#### Before Submitting A Bug Report | ||
|
||
**Perform a [cursory search](https://github.com/textileio/textile-mobile/labels/bug)** | ||
to see if the problem has already been reported. If it does exist, add a | ||
:thumbsup: to the issue to indicate this is also an issue for you, and add a | ||
comment to the existing issue if there is extra information you can contribute. | ||
|
||
#### How Do I Submit A (Good) Bug Report? | ||
|
||
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). | ||
|
||
Simply create an issue on the [Textile issue tracker](https://github.com/textileio/textile-mobile/issues). | ||
|
||
The information we are interested in includes: | ||
|
||
- details about your environment - which build, which operating system | ||
- details about reproducing the issue - what steps to take, what happens, how | ||
often it happens | ||
- other relevant information - log files, screenshots, etc. | ||
|
||
### Suggesting Enhancements | ||
|
||
This section guides you through submitting an enhancement suggestion for | ||
Textile Mobile, including completely new features and minor improvements to | ||
existing functionality. Following these guidelines helps maintainers and the | ||
community understand your suggestion :pencil: and find related suggestions | ||
:mag_right:. | ||
|
||
Before creating enhancement suggestions, please check [this list](https://github.com/textileio/textile-mobile/labels/bug) | ||
as you might find out that you don't need to create one. When you are creating | ||
an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Include the steps | ||
that you imagine you would take if the feature you're requesting existed. | ||
|
||
#### Before Submitting An Enhancement Suggestion | ||
|
||
**Perform a [cursory search](https://github.com/textileio/textile-mobile/labels/enhancement)** | ||
to see if the enhancement has already been suggested. If it has, add a | ||
:thumbsup: to indicate your interest in it, or comment if there is additional | ||
information you would like to add. | ||
|
||
#### How Do I Submit A (Good) Enhancement Suggestion? | ||
|
||
Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). | ||
|
||
Simply create an issue on the [Textile issue tracker](https://github.com/textileio/textile-mobile/issues) | ||
and provide the following information: | ||
|
||
* **Use a clear and descriptive title** for the issue to identify the | ||
suggestion. | ||
* **Provide a step-by-step description of the suggested enhancement** in as | ||
much detail as possible. This additional context helps the maintainers to | ||
understand the enhancement from your perspective | ||
* **Explain why this enhancement would be useful** to Textile users. | ||
* **Include screenshots and animated GIFs** if relevant to help you demonstrate | ||
the steps or point out the part of Textile which the suggestion is | ||
related to. | ||
* **List some other applications where this enhancement exists, if applicable.** | ||
|
||
## Additional Notes | ||
|
||
### Issue Labels | ||
|
||
This section lists the labels we use to help us track and manage issues and | ||
pull requests. | ||
|
||
| Label name | :mag_right: | Description | | ||
| --- | --- | --- | | ||
| `enhancement` | [search](https://github.com/textileio/textile-mobile/labels/enhancement) | Feature requests. | | ||
| `bug` | [search](https://github.com/textileio/textile-mobile/labels/bug) | Confirmed bugs or reports that are very likely to be bugs. | | ||
| `more-information-needed` | [search](https://github.com/textileio/textile-mobile/labels/more-information-needed) | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). | | ||
| `reviewer-needs-to-reproduce` | [search](https://github.com/textileio/textile-mobile/labels/reviewer-needs-to-reproduce) | Likely bugs, but haven't been reliably reproduced by a reviewer. | | ||
| `stale` | [search](https://github.com/textileio/textile-mobile/labels/stale) | Issues that are inactive and marked to be closed. | | ||
| `iOS` | [search](https://github.com/textileio/textile-mobile/labels/iOS) | Issues specific to iOS users. | | ||
| `Android` | [search](https://github.com/textileio/textile-mobile/labels/Android) | Issues specific to Android users. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2018 Textile | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters