Permalink
Browse files

Couple improvements to the readme

  • Loading branch information...
rap1ds committed Jul 6, 2017
1 parent 30cfa96 commit 65c2bdbcec1e36827f1134975d01cf053b2c013b
Showing with 32 additions and 17 deletions.
  1. +13 −7 README.md
  2. +19 −10 docs/how-to-handle-github-issues.md
View
@@ -7,7 +7,8 @@ Sharetribe is an open source platform to create your own peer-to-peer marketplac
Would you like to set up your marketplace in one minute without touching code? [Head to Sharetribe.com](https://www.sharetribe.com).
### Contents
- [Tech Stack](#tech-stack)
- [Technology stack](#technology-stack)
- [Installation](#installation)
- [Payments](#payments)
- [Versioning](#versioning)
@@ -17,11 +18,12 @@ Would you like to set up your marketplace in one minute without touching code? [
- [Release](#release)
- [Technical roadmap](#technical-roadmap)
- [Translation](#translation)
- [Known issues](#known-issues)
- [Bug tracker](#bug-tracker)
- [Documentation](#documentation)
- [Community forum](#community-forum)
- [License](#mit-license)
## Tech Stack
## Technology stack
- Ruby 2.3
- Ruby on Rails 5.1.1
@@ -32,8 +34,8 @@ Would you like to set up your marketplace in one minute without touching code? [
- Deploy: Custom Script (not using Mina or Cap3)
- Server: Heroku
- Image hosting: Amazon S3
- Background job: `[delayed_job](https://github.com/collectiveidea/delayed_job)`
- Gem:
- Background job: [delayed_job](https://github.com/collectiveidea/delayed_job)
- Gems:
- [devise](https://github.com/plataformatec/devise) | Authentication
- [omniauth-facebook](https://github.com/mkdynamic/omniauth-facebook) | Third party login: Facebook
- [haml](https://github.com/haml/haml) and ERB | HTML teamplating
@@ -434,9 +436,13 @@ Sharetribe uses [WebTranslateIt (WTI)](https://webtranslateit.com/en) for transl
All language additions and modifications (except for English) should be done through the WTI tool. We do not accept Pull Requests that add or modify languages (except English).
## Known issues
## Bug tracker
Browse open issues and submit new ones in [Github Issues](http://github.com/sharetribe/sharetribe/issues).
We are dedicating the Github Issue only for bugs in the Sharetribe codebase. For general questions, start a new thread in the [Community forum](https://www.sharetribe.com/community/) instead of opening a new Issue.
Browse open issues and submit new ones at http://github.com/sharetribe/sharetribe/issues.
After you have opened a new issue, the team will handle it according to these instructions: [How to handle Github Issues](https://github.com/sharetribe/sharetribe/blob/master/docs/how-to-handle-github-issues.md)
## Documentation
@@ -2,20 +2,29 @@
*(This document is targeted mainly to Sharetribe team, but it's also good information for anyone who is about to file a new Issue report)*
Does the report contain enough information to reproduce the issue?
### New issues
- *Yes:* Try to reproduce it.
- *No:* Add a label **more information needed** and ask more info.
1. Is it a general question or a bug report?
Can you reproduce the issue?
- *Question:* Leave it open for some time and see if it creates traction and discussion. If it becomes inactive, close it and add a friendly reminder that the [Community Forum](https://www.sharetribe.com/community/) is the right place for general questions and discussion.
- *Bug:* Move on to step 2.
- *Yes:* Add a label **bug**.
- *No:* Close the issue, unless you feel this does needs further investigation. Leave the issue open and ask for further feedback from others, if so.
2. Does the report contain enough information to reproduce the issue?
Is there an Issue with label **more information needed** and the issue reporter hasn't answered in two weeks?
- *Yes:* Try to reproduce it. Move on to step 3.
- *No:* Add a label **[more information needed]** and ask more info.
- *Yes:* Close the issue as inactive
3. Can you reproduce the issue?
Is there an Issue with a label "bug" and you know how to fix it?
- *Yes:* Add a label **[bug]**.
- *No:* Close the issue, unless you feel this does needs further investigation. Leave the issue open and ask for further feedback from others, if so.
- *Yes:* Do it!
### Existing issues
- Is there an Issue with label **[more information needed]** and the issue reporter hasn't answered in two weeks?
- *Yes:* Close the issue as inactive
- Is there an Issue with a label **[bug]** and you know how to fix it?
- *Yes:* Do it!

0 comments on commit 65c2bdb

Please sign in to comment.