Skip to content

armgit / fider

Public Imported from GitHub
0

Open platform to collect and prioritize feedback

docs: activating Open Collective (#358)

jess79633a0cbd85
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ee2e93958..1c946bcc5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,24 +1,24 @@
-# Contributing to Fider
+# Contributing
-## Ways to contribute
+There are many ways to contribute to Fider.
-- **Send us a Pull Request** on GitHub. Make sure you read our [Getting Started](#getting-started-with-fider-codebase) guide.
-- **Reporting issues** and bug reports on (https://github.com/getfider/fider).
-- **Giving feedback** and voting on features you'd like to see at https://feedback.fider.io.
-- **Spread the word!** Star us on GitHub, tweet about us, show it to your friends. The more people are aware of Fider, the bigger the community and the contributions will be.
-- **Support us financially** Donate any amount to our [OpenCollective](https://opencollective.com/fider) and help us continue our activities.
+- **Send us a Pull Request** on GitHub. Make sure you read our [Getting Started](#getting-started-with-fider-codebase) guide to learn how to setup the development environment;
+- **Report issues** and bug reports on https://github.com/getfider/fider/issues;
+- **Give feedback** and voting on features you'd like to see at https://feedback.fider.io;
+- **Spread the word** by starring us on GitHub. Tweet about us and show it to your friends. The more people are aware of Fider, the bigger the community will be and more contributions will be made;
+- **Support us financially** by donating any amount to our [OpenCollective](https://opencollective.com/fider) and help us continue our activities;
## Getting started with Fider codebase
-Before youstart working on something that you intend to send a Pull Request back to Fider, make sure there's an [GitHub Issue](https://github.com/getfider/fider/issues) open for that. If you're working on something not tracked yet, please open a new Issue before the Pull Request.
+Before you start working on something that you intend to send a Pull Request to Fider, make sure there's an [GitHub Issue](https://github.com/getfider/fider/issues) open for that. If you're working on something not tracked yet, please open a new Issue before the Pull Request.
-Fider is mainly written in Go and TypeScript, but we're also using things like Node.js, React and PostgreSQL.
+Fider is mainly written in Go and TypeScript, but we're also using things like Node.js, React and PostgreSQL.
If you know these technologies or would like to learn them, lucky you! This is the right place!
Install the following tools:
-- Go 1.10 (https://golang.org/)
-- Node.js 8.x (https://nodejs.org/)
+- Go 1.10+ (https://golang.org/)
+- Node.js 8+ (https://nodejs.org/)
- Docker (https://www.docker.com/)
- github.com/codegangsta/gin (https://github.com/codegangsta/gin/)
@@ -34,4 +34,4 @@ To setup your development workspace:
To run the unit tests:
1) run `docker-compose up -d pgtest` to start a test-only PostgreSQL database on Docker.
-2) run `make test`.
+2) run `make test`.
\ No newline at end of file
diff --git a/README.md b/README.md
index 8c7398b9a..e65d2178f 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,65 @@
-![](/public/assets/images/logo-small.png)
+<p align="center">
+ <a href="https://github.com/getfider/fider">
+ <img src="public/assets/images/logo-small.png" />
+ </a>
+ <h1 align="center">Fider</h1>
+ <div align="center">
+ <strong>A platform to collect and organize customer feedback.</strong>
+ </div>
+ <div align="center">Let your customers share, vote and discuss on suggestions they have to make your product even better.</div>
+</p>
-# Fider &middot; [![CircleCI](https://circleci.com/gh/getfider/fider/tree/master.svg?style=svg)](https://circleci.com/gh/getfider/fider/tree/master) [![codecov](https://codecov.io/gh/getfider/fider/branch/master/graph/badge.svg)](https://codecov.io/gh/getfider/fider)
+<div align="center">
+ <h3>
+ <a href="https://getfider.com">
+ Website
+ </a>
+ <span> | </span>
+ <a href="https://feedback.fider.io/">
+ See it in action
+ </a>
+ </h3>
+</div>
-Fider is an open platform to collect and organize customer feedback. By using the platform, your community can share, vote and discuss on ideas they have to make your product or company even better.
+<div align="center">
+ <sub>Built with ❤︎ by <a href="https://github.com/goenning">Guilherme Oenning</a> and <a href="graphs/contributors">contributors</a></sub>
+</div>
-You can [see it in action](https://feedback.fider.io/) or visit https://getfider.com to learn more about all features and how to get started.
+<br />
-![](etc/homepage.png)
+<img src="etc/homepage.png">
-# Want to contribute?
+## Contributors
-[Feedback for Fider](https://feedback.fider.io/) is the entry point for any new feature request. We use our own platform for users to share and vote on what they would like to see implemented on Fider.
+This project exists thanks to all the people who contribute.
-[GitHub Issues](https://github.com/getfider/fider/issues) is created for every **accepted feature request**, **technical request** or **bugs**. Every issue should briefly describes what's the work involved and it'll be used to track progress on its development.
+<a href="graphs/contributors"><img src="https://opencollective.com/fider/contributors.svg?width=890&button=false" /></a>
-We have a monthly [GitHub Milestone](https://github.com/getfider/fider/milestones) that lists everything that is due to be released on that month.
+Read our [CONTRIBUTING](CONTRIBUTING.md) guide to learn the many ways you can contribute to Fider.
-* **Found a bug?** Create an issue on [GitHub](https://github.com/getfider/fider/issues).
-* **Want to request a feature?** Suggest it on [Feedback for Fider](https://feedback.fider.io/).
-* **Got a question?** Send a Tweet to [@getfider](twitter.com/getfider) or email [email protected].
-* **Want to donate?** Become a backer on [OpenCollective](https://opencollective.com/fider) and help us continue our activities.
+## Sponsors
-Read how you can help the project on [CONTRIBUTING.md](CONTRIBUTING.md).
+Thanks to [BrowserStack](https://browserstack.com/) for providing us with free cross-browser testing for Fider.
+
+<a href="https://browserstack.com" target="_blank">
+ <img src="etc/browserstack.png">
+</a>
+
+Does your organization use Fider? [Become a sponsor](https://opencollective.com/fider) and your logo will show up here with a link to your website.
+
+<a href="https://opencollective.com/fider/sponsors/0/website" target="_blank"><img src="https://opencollective.com/fider/sponsors/0/avatar"></a>
+<a href="https://opencollective.com/fider/sponsors/1/website" target="_blank"><img src="https://opencollective.com/fider/sponsors/1/avatar"></a>
+<a href="https://opencollective.com/fider/sponsors/2/website" target="_blank"><img src="https://opencollective.com/fider/sponsors/2/avatar"></a>
+<a href="https://opencollective.com/fider/sponsors/3/website" target="_blank"><img src="https://opencollective.com/fider/sponsors/3/avatar"></a>
+<a href="https://opencollective.com/fider/sponsors/4/website" target="_blank"><img src="https://opencollective.com/fider/sponsors/4/avatar"></a>
+
+## Backers
+
+Thank you to all our backers! 🙏
+
+<a href="https://opencollective.com/fider" target="_blank">
+ <img src="https://opencollective.com/fider/backers.svg?width=890">
+</a>
-# Sponsors
-Thanks to [BrowserStack](https://browserstack.com/) for providing us with free cross-browser testing for Fider.
-[![](etc/browserstack.png)](https://browserstack.com/)
\ No newline at end of file
diff --git a/etc/homepage.png b/etc/homepage.png
index 80ba26dfd..ca96bf7dd 100644
Binary files a/etc/homepage.png and b/etc/homepage.png differ