From e5cddeba778faead5be5512968c8507a25983f62 Mon Sep 17 00:00:00 2001 From: joshua stein Date: Sun, 24 Feb 2013 19:52:09 -0600 Subject: [PATCH] update readme/contributing to explain about non-lobste.rs use --- CONTRIBUTING.md | 10 +++++++++- README.md | 16 +++++++++++----- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 779bb76..cf22a7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,23 @@ +####Licensing + The `lobsters` codebase is under a [3-clause BSD license](https://github.com/jcs/lobsters/blob/master/LICENSE). All code submitted must be licensed under these or more-permissive terms (2-clause BSD, MIT, ISC, etc.). -### Making Changes +####Before Making Changes + +While this project's license allows for modification and use to run your own +website, this source code repository is for the code running the website at +[lobste.rs](https://lobste.rs/). Not all changes or new features submitted will be accepted. Please discuss your proposed changes on [/t/meta](https://lobste.rs/t/meta) or as a [Github issue](https://github.com/jcs/lobsters/issues) before working on them to avoid wasted efforts. +###Making Changes + * Fork [jcs/lobsters](https://github.com/jcs/lobsters) on Github. * (Optional) Create a branch to house your changes. diff --git a/README.md b/README.md index fdc572c..b20687c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,17 @@ This is the source code to the site operating at SQL (MySQL in production) backend for the database and Sphinx for the search engine. +While you are free to fork this code and modify it (according to the [license](https://github.com/jcs/lobsters/blob/master/LICENSE)) +to run your own link aggregation website, this source code repository and bug +tracker are only for the site operating at [lobste.rs](https://lobste.rs/). +Please do not use the bug tracker for support related to operating your own +site unless you are contributing code that will also benefit [lobste.rs](https://lobste.rs/). + +####Contributing bugfixes and new features + +Please see the [CONTRIBUTING](https://github.com/jcs/lobsters/blob/master/CONTRIBUTING.md) +file. + ####Initial setup * Install Ruby 1.9.3. @@ -71,8 +82,3 @@ You should define this in `/etc/hosts` (or through DNS) to point to `http://lobsters.localhost:3000` with your `test` user: lobsters$ rails server - -####Contributing bugfixes and new features - -Please see the [CONTRIBUTING](https://github.com/jcs/lobsters/blob/master/CONTRIBUTING.md) -file.