Skip to content

Latest commit

 

History

History
136 lines (95 loc) · 6 KB

CONTRIBUTING.md

File metadata and controls

136 lines (95 loc) · 6 KB
Raw

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

How Can I Contribute?

Additional Notes

What should I know before I get started?

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to contact@textile.io.

How Can I Contribute?

Developing locally

How to Setup

Step 1: git clone this repo:

Step 2: cd to the cloned repo:

Step 3: Install the Application with yarn or npm i

How to Run App

  1. cd to the repo
  2. Run Build for either OS
  • for iOS
    • run react-native run-ios
  • for Android
    • Run Genymotion
    • run react-native run-android

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

Before Submitting A Bug Report

Perform a cursory search 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.

Simply create an issue on the Textile issue tracker.

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 📝 and find related suggestions 🔎.

Before creating enhancement suggestions, please check this list 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. 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 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.

Simply create an issue on the Textile issue tracker 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 🔎 Description
enhancement search Feature requests.
bug search Confirmed bugs or reports that are very likely to be bugs.
more-information-needed search More information needs to be collected about these problems or feature requests (e.g. steps to reproduce).
reviewer-needs-to-reproduce search Likely bugs, but haven't been reliably reproduced by a reviewer.
stale search Issues that are inactive and marked to be closed.
iOS search Issues specific to iOS users.
Android search Issues specific to Android users.