mirror of
https://github.com/discourse/discourse.git
synced 2024-11-29 12:13:58 -06:00
update readme and authors
This commit is contained in:
Jeff Atwood
parent
7087c2b847
commit
ff92fc900c
41
README.md
41
README.md
@ -28,7 +28,7 @@ Discourse is a **Civilized Discourse Construction Kit**, an 100% open-source dis
|
||||
|
||||
Key Discourse mission goals:
|
||||
|
||||
- A **flattened, endlessly scrolling discussion**, avoiding the akwardness of traditionally threaded and paginated discussion, while allowing replies to be expanded in place for additional context.
|
||||
- A **flattened, endlessly scrolling discussion**, avoiding the awkardness of traditionally threaded and paginated discussion, while allowing replies to be expanded in place for additional context.
|
||||
|
||||
- A **user trust system** that grants users additional rights to assist in moderating the forum as they participate in good faith over time. The goal is for the forum to be nearly self-moderating in the absence of any formal moderators, although excellent moderators accelerate the process greatly.
|
||||
|
||||
@ -41,7 +41,7 @@ The Discourse team wishes to **foster an active community of contributors**, all
|
||||
This vision translates to the following functional commitments:
|
||||
|
||||
1. Support only modern browsers on the desktop:
|
||||
- Internet Explorer 9.0, 10.0+
|
||||
- Internet Explorer 9.0 (may not be fully functional), 10.0+
|
||||
- Firefox 16+
|
||||
- Google Chrome 23+
|
||||
- Safari 5+
|
||||
@ -64,53 +64,42 @@ accepts contributions from the public, and we'd like you to be a part of that co
|
||||
|
||||
Before contributing to Discourse, please:
|
||||
|
||||
1. Review the [**VISION**](#vision) section above, which will help you understand the needs of the team, and the focus of the project,
|
||||
1. Review the [**VISION**](#vision) statement, to confirm that you understand the needs of the team and the focus of the project,
|
||||
2. Read and sign the [**Electronic Discourse Forums Contribution License Agreement**](http://discourse.org/cla), to confirm you've read and acknowledged the legal aspects of your contributions, and
|
||||
3. Dig into [**CONTRIBUTING.MD**](https://github.com/discourse/discourse/blob/master/docs/CONTRIBUTING.md), which houses all of the necessary info to:
|
||||
- submit bugs,
|
||||
- request new features, and
|
||||
- step you through the entire process of preparing your code for a Pull Request.
|
||||
4. Have a look here: http://meta.discourse.org/t/so-you-want-to-help-out-with-discourse/3823
|
||||
4. For ideas about areas of Discourse that need your assistance with, see http://meta.discourse.org/t/so-you-want-to-help-out-with-discourse/3823
|
||||
|
||||
**We look forward to seeing your cool stuff!**
|
||||
|
||||
## Expertise
|
||||
|
||||
In order to be an effective contributor, familiarize yourself with the various open source components that Discourse is built on:
|
||||
Discourse is built from the following open source components:
|
||||
|
||||
### Languages/Frameworks
|
||||
- [Ruby on Rails](https://github.com/rails/rails) - Our back end API is a Rails app. It responds to requests RESTfully and responds in JSON.
|
||||
- [Ember.js](https://github.com/emberjs/ember.js) - Our front end is an Ember.js app that communicates with the Rails API.
|
||||
- [PostgreSQL](http://www.postgresql.org/) - Our main data store is in Postgres.
|
||||
- [Redis](http://redis.io/) - We use Redis for our job queue, rate limiting, as a cache and for transient data.
|
||||
|
||||
1. [Ruby on Rails](https://github.com/rails/rails) - Our back end API is a Rails app. It responds to requests RESTfully and responds in JSON.
|
||||
2. [Ember.js](https://github.com/emberjs/ember.js) - Our front end interface is an Ember.js app that communicates with the Rails API.
|
||||
|
||||
### Databases
|
||||
|
||||
1. [PostgreSQL](http://www.postgresql.org/) - Our main data store is Postgres.
|
||||
2. [Redis](http://redis.io/) - We use Redis for our job queue, rate limiting, as a cache and for transient data.
|
||||
|
||||
### Ruby Gems
|
||||
|
||||
The complete list of Ruby Gems used by Discourse can be found in [**SOFTWARE.MD**](https://github.com/discourse/discourse/blob/master/docs/SOFTWARE.md).
|
||||
Plus *lots* of Ruby Gems, a complete list of which is at [**SOFTWARE.MD**](https://github.com/discourse/discourse/blob/master/docs/SOFTWARE.md).
|
||||
|
||||
## Versioning
|
||||
|
||||
Discourse implements the Semantic Versioning guidelines.
|
||||
Discourse implements the [Semantic Versioning guidelines](http://semver.org/).
|
||||
|
||||
Releases will be numbered with the following format:
|
||||
|
||||
`<major>.<minor>.<patch>`
|
||||
|
||||
And constructed with the following guidelines:
|
||||
|
||||
- Breaking backward compatibility bumps the major (and resets the minor and patch)
|
||||
- New additions without breaking backward compatibility bumps the minor (and resets the patch)
|
||||
- Bug fixes and misc changes bumps the patch
|
||||
|
||||
For more information on SemVer, please visit http://semver.org/.
|
||||
|
||||
## The Discourse Team
|
||||
|
||||
The Discourse code contributors can be found in [**AUTHORS.MD**](https://github.com/discourse/discourse/blob/master/docs/AUTHORS.md). For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to the official website.
|
||||
The original Discourse code contributors can be found in [**AUTHORS.MD**](https://github.com/discourse/discourse/blob/master/docs/AUTHORS.md). For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to [the official Discourse website](http://www.discourse.org).
|
||||
|
||||
## Copyright / License
|
||||
|
||||
@ -127,3 +116,9 @@ distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
Discourse logo and “Discourse Forum” ®, Civilized Discourse Construction Kit, Inc.
|
||||
|
||||
## Dedication
|
||||
|
||||
Discourse is built with [love, Internet style.](http://www.youtube.com/watch?v=Xe1TZaElTAs)
|
||||
@ -1,19 +1,19 @@
|
||||
# The Discourse Team
|
||||
|
||||
* Jeff Atwood - Founder, Principal Overlord, Lead Systems Design
|
||||
* Jeff Atwood - Co-Founder, PM
|
||||
|
||||
* Robin Ward - Co-Founder, Ruby developer
|
||||
|
||||
* Sam Saffron - Co-Founder, Ruby developer
|
||||
|
||||
* Neil Lalonde - Ruby Developer
|
||||
* Neil Lalonde - Ruby developer
|
||||
|
||||
* Ryan Mudryk - UI Implementation, supplemental
|
||||
### Special Thanks To
|
||||
|
||||
### Specials Thanks To
|
||||
* Nick Sahler - Intern
|
||||
|
||||
* Nick Sahler - UI Implementation, supplemental
|
||||
* Ryan Mudryk - CSS and HTML design implementation
|
||||
|
||||
* Don Petersen - Ruby developer, installation scripts
|
||||
|
||||
*For a more detailed list of the many individuals that contributed to the design and development of Discourse outside of GitHub, please refer to the official Discourse website.*
|
||||
*This is only a list of people who contributed code to Discourse at the time of public launch on February 5th, 2013. For a more detailed list of the many individuals that contributed to the design and development of Discourse outside of GitHub, please refer to [the official Discourse website](http://www.discourse.org).*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user