From b9c9e1c4fdc44ebb8abd4d18c972d4c0778bea4e Mon Sep 17 00:00:00 2001 From: Thomas Wilburn Date: Tue, 29 Apr 2014 22:26:59 -0700 Subject: [PATCH] Added contributing guide and license information. --- contributing.txt | 16 ++++++++++++++++ license.txt | 12 ++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 contributing.txt create mode 100644 license.txt diff --git a/contributing.txt b/contributing.txt new file mode 100644 index 0000000..8290e00 --- /dev/null +++ b/contributing.txt @@ -0,0 +1,16 @@ +CONTRIBUTING TO CARET: + +Help is always welcome when it comes to making Caret the best editor it can be. This is not just limited to code, but also to documentation, bug reports, and feature requests. To contribute, visit our GitHub repo: + +https://github.com/thomaswilburn/Caret + +We use GitHub's issue system to track bugs and feature requests, so feel free to start there. You can also grab a copy of the source code from the repo. Feel free to file a pull request, but do note that all contributions must go through a thorough code review before being accepted, and you may be asked to revise your code to match Caret's style and structure. Below are a few notes to help reduce surprises in that department: + +* In general, use the Google JS style guide, with a few exceptions due to orneriness. +* Caret style prefers double quotes to single quotes when writing strings. We also ignore the style guide when it comes to AMD module declarations, but other function declarations should follow the Google style. +* JSDoc is not used in Caret, but would probably be a good idea. Comment heavily, but name your variables and write your code so that comments shouldn't be necessary. You should prefer clarity to cleverness. +* For the most part, we use relatively few outside libraries besides Ace and the ES6 Promise shim. Before including other external libraries, consider whether this is truly necessary. For example, there are libraries for providing async and DOM manipulation in /util that should be used, rather than including caolan's async library or jQuery. This micro-library approach has served Caret well--consider deeply whether you need to include a large external library for your contribution. +* Once AMD modules start to exceed 200 lines, it's a good idea to try breaking them up into primary packages with imported sub-modules. See the "session" module for an example. +* Caret uses Grunt as its build system, and you will need it installed for development. If your contribution generates files, such as templates or CSS, do not check in the generated files, but do make sure that they will be generated as a part of the Grunt "package" task. + +You don't have to be a coder to help with Caret--we're always looking for designers, writers, testers, and other non-code tasks. If you'd like suggestions on where to start, send an e-mail. Contact information is available from the main project marketing page at http://thomaswilburn.net/caret \ No newline at end of file diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..ecdc2fd --- /dev/null +++ b/license.txt @@ -0,0 +1,12 @@ +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . \ No newline at end of file